Use README file w TypeDoc, add generated globals.md to .gitignore

Author: crandmck

.github/workflows/publish-docs.yml

@@ -3,11 +3,11 @@ name: Build and publish docs
 on:
 
 pull_request:
-      types:
-        - opened
-        - reopened
-        - synchronize
-        - labeled
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - labeled
 # release:
 #   types: [published]
 
@@ -30,9 +30,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-        with:
-          filter: tree:0
-          fetch-depth: 0
 
       - name: Setup Pages
         uses: actions/configure-pages@v5
@@ -50,8 +47,7 @@ jobs:
 
       - name: Generate TypeDoc markdown (without modifying repo)
         run: |
-          pnpm typedoc --plugin typedoc-plugin-markdown --readme none --out docs-typedoc js-src/index.ts
-          pnpm cpy "docs-typedoc/**" docs --parents --overwrite --ignore="docs-typedoc/classes/index.md" --ignore="docs-typedoc/README.md"
+          pnpm run build:docs
           rm -rf docs-typedoc
 
       - name: Upload artifact

docs/.gitignore

@@ -4,3 +4,5 @@ _site
 .jekyll-metadata
 vendor
 Gemfile.lock
+
+globals.md

docs/classes/.gitignore

@@ -0,0 +1,8 @@
+# Ignore everything
+*.md
+
+# Don't ignore .gitignore itself
+!.gitignore
+
+# Don't ignore the README file
+!index.md

docs/functions/.gitignore

@@ -0,0 +1,8 @@
+# Ignore everything
+*.md
+
+# Don't ignore .gitignore itself
+!.gitignore
+
+# Don't ignore the README file
+!index.md

docs/interfaces/.gitignore

@@ -0,0 +1,8 @@
+# Ignore everything
+*.md
+
+# Don't ignore .gitignore itself
+!.gitignore
+
+# Don't ignore the README file
+!index.md

docs/type-aliases/.gitignore

@@ -0,0 +1,8 @@
+# Ignore everything
+*.md
+
+# Don't ignore .gitignore itself
+!.gitignore
+
+# Don't ignore the README file
+!index.md

package.json

@@ -22,7 +22,7 @@
   "scripts": {
     "build": "run-s build:rust build:ts",
     "build:debug": "run-s build:rust-debug build:ts",
-    "build:docs": "rimraf docs-typedoc && typedoc --plugin typedoc-plugin-markdown --readme none --out docs-typedoc js-src/index.ts && cpy \"docs-typedoc/**\" docs --parents --overwrite --ignore=\"docs-typedoc/classes/index.md\" --ignore=\"docs-typedoc/README.md\" && rimraf docs-typedoc",
+    "build:docs": "rimraf docs-typedoc && typedoc --plugin typedoc-plugin-markdown --readme README.md --out docs-typedoc js-src/index.ts && cpy \"docs-typedoc/**\" docs --parents --overwrite --ignore=\"docs-typedoc/classes/index.md\" --ignore=\"docs-typedoc/README.md\" && rimraf docs-typedoc",
     "build:rust": "pnpm run build:rust-debug --release",
     "build:rust-debug": "cargo build --message-format=json-render-diagnostics > cargo.log",
     "build:ts": "tsc -b && cpy index.node dist && cpy index.node js-src && cpy --flat js-src/types.d.ts dist/types",