Set up typedoc for realm-react, realm-web

.gitignore

@@ -128,3 +128,5 @@ integration-tests/**/.lock
 
 # Generated docs
 /packages/realm/docs/
+/packages/realm-react/docs/
+/packages/realm-web/docs/

packages/realm-react/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img height="140" src="logo.svg" alt="Realm React Logo"/>
+  <img height="140" src="media/realm-react-logo.svg" alt="Realm React Logo"/>
 </p>
 
 <h1 align="center">

packages/realm-react/media

@@ -0,0 +1 @@
+../../media

packages/realm-react/package.json

@@ -9,9 +9,9 @@
   "scripts": {
     "bundle": "wireit",
     "start": "npm run build -- --watch",
-    "test": "jest --forceExit",
     "test": "wireit",
-    "lint": "eslint --ext .tsx ."
+    "lint": "eslint --ext .tsx .",
+    "docs": "wireit"
   },
   "wireit": {
     "bundle": {
@@ -30,6 +30,12 @@
         "../realm:build:node",
         "../realm-common:bundle"
       ]
+    },
+    "docs": {
+      "command": "typedoc",
+      "dependencies": [
+        "bundle"
+      ]
     }
   },
   "dependencies": {

packages/realm-react/typedoc.json

@@ -0,0 +1,11 @@
+{
+  "entryPoints": ["src/index.tsx"],
+  "tsconfig": "./tsconfig.json",
+  "excludeInternal": true,
+  "customCss": "../../typedoc/style.css",
+  "media": "./media",
+  "name": "Realm React",
+  "includeVersion": true,
+  "sourceLinkTemplate": "https://github.com/realm/realm-js/blob/{gitRevision}/{path}#L{line}",
+  "favicon": "../../media/favicon.ico"
+}

packages/realm-web/package.json

@@ -16,7 +16,8 @@
     "start": "npm run build -- --watch",
     "lint": "eslint --ext .js,.ts .",
     "test": "mocha 'src/tests/**/*.test.ts'",
-    "postversion": "ts-node --project scripts/tsconfig.json scripts/postversion.ts"
+    "postversion": "ts-node --project scripts/tsconfig.json scripts/postversion.ts",
+    "docs": "wireit"
   },
   "wireit": {
     "bundle": {
@@ -35,6 +36,10 @@
       "command": "ts-node --project scripts/tsconfig.json scripts/update-types.ts",
       "files": ["../../types"],
       "output": ["types/realm"]
+    },
+    "docs": {
+      "command": "typedoc",
+      "dependencies": ["bundle"]
     }
   },
   "files": [

packages/realm-web/typedoc.json

@@ -0,0 +1,11 @@
+{
+  "entryPoints": ["src/index.ts"],
+  "tsconfig": "./tsconfig.json",
+  "excludeInternal": true,
+  "customCss": "../../typedoc/style.css",
+  "media": "../../media",
+  "name": "Realm Web",
+  "includeVersion": true,
+  "sourceLinkTemplate": "https://github.com/realm/realm-js/blob/{gitRevision}/{path}#L{line}",
+  "favicon": "../../media/favicon.ico"
+}

packages/realm/typedoc.json

@@ -2,7 +2,7 @@
   "entryPoints": ["src/index.ts"],
   "tsconfig": "./tsconfig.json",
   "excludeInternal": true,
-  "customCss": "./typedoc/styles.css",
+  "customCss": "../../typedoc/style.css",
   "media": "../../media",
   "name": "Realm JavaScript",
   "includeVersion": true,