docs: embed generated api documents (remirror#1257)

.github/workflows/docs.yml

@@ -35,14 +35,19 @@ jobs:
       - name: setup node.js
         uses: actions/setup-node@v2
         with:
-          # Uses node 14 to allow nullish coalescing in `.js` files
-          node-version: 14
+          node-version: 16
 
       - name: install and audit
         uses: ./support/actions/pnpm
         with:
           cache: ${{ env.PNPM_CACHE_FOLDER }}
 
+      - name: generate .d.ts files
+        run: pnpm build
+
+      - name: generate api markdown files
+        run: pnpm api
+
       - name: build docs
         run: pnpm build:docs
 

.gitignore

@@ -160,16 +160,14 @@ support/api/**
 /commitlint.config.js
 /jest-playwright.config.cjs
 /jest.config.e2e.js
+/api-documenter.json
 
 ## Ignore tsconfig files since all tsconfig files are autogenerated.
 /tsconfig.json
 /tsconfig.dev.json
 /tsconfig.lint.json
-/tsconfig.docs.json
 
 ## Storybook
 **/storybook-static
 
-/typedoc.json
-
 .linaria-cache

package.json

@@ -8,7 +8,7 @@
   },
   "type": "module",
   "scripts": {
-    "api": "node support/scripts/generate-api && api-documenter markdown -i ./support/api -o ./docs/api",
+    "api": "node support/scripts/generate-api && api-documenter generate -i ./support/api -o ./docs/api",
     "browser:coverage": "browserslist --coverage",
     "build": "run-p build:core css:copy",
     "build:core": "preconstruct build",
@@ -143,8 +143,8 @@
     "@lingui/macro": "^3.10.2",
     "@lingui/react": "^3.10.2",
     "@manypkg/cli": "^0.18.0",
-    "@microsoft/api-documenter": "^7.13.50",
-    "@microsoft/api-extractor": "^7.18.4",
+    "@microsoft/api-documenter": "^7.13.52",
+    "@microsoft/api-extractor": "^7.18.9",
     "@preconstruct/cli": "^2.0.7",
     "@size-limit/preset-big-lib": "^5.0.1",
     "@testing-library/dom": "^8.1.0",
@@ -175,6 +175,7 @@
     "cpy-cli": "^3.1.1",
     "cross-env": "^7.0.3",
     "delay": "^5.0.0",
+    "doc-plugin-remirror": "^0.2.1",
     "downlevel-dts": "^0.7.0",
     "eslint": "^7.30.0",
     "eslint-config-prettier": "^8.2.0",

support/root/api-documenter.json

@@ -0,0 +1,9 @@
+{
+  "outputTarget": "markdown",
+  "plugins": [
+    {
+      "packageName": "doc-plugin-remirror",
+      "enabledFeatureNames": ["remirror-feature"]
+    }
+  ]
+}