feat(docusaurus): decouple typedoc logic into dedicated "typedoc-docusaurus-theme" plugin

Author: tgreyuk

.changeset/bumpy-dolls-teach.md

@@ -0,0 +1,7 @@
+---
+'docusaurus-plugin-typedoc': minor
+'typedoc-docusaurus-theme': minor
+---
+
+- Decoupled TypeDoc logic into a separate plugin, "typedoc-docusaurus-theme". "docusaurus-plugin-typedoc" and "typedoc-docusaurus-theme" will now be published and versioned together as linked packages.
+- Unquoted object keys in generated sidebar.

.changeset/config.json

@@ -5,7 +5,7 @@
     { "repo": "typedoc2md/typedoc-plugin-markdown" }
   ],
   "commit": false,
-  "fixed": [],
+  "fixed": [["docusaurus-plugin-typedoc", "typedoc-docusaurus-theme"]],
   "linked": [],
   "access": "public",
   "baseBranch": "main",

.github/workflows/ci.docusaurus-plugin-typedoc.yml

@@ -32,10 +32,10 @@ jobs:
           node-version: ${{ matrix.node }}
           cache: 'npm'
       - name: Install
-        run: HUSKY=0 npm install
+        run: HUSKY=0 npm ci
       - name: Lint
         run: npm run lint --workspace docusaurus-plugin-typedoc
       - name: Build
-        run: npm run build --workspace typedoc-plugin-markdown --workspace docusaurus-plugin-typedoc
+        run: npm run build --workspace typedoc-plugin-markdown --workspace typedoc-docusaurus-theme --workspace docusaurus-plugin-typedoc
       - name: Test
         run: npm run test --workspace docusaurus-plugin-typedoc

.github/workflows/ci.typedoc-docusaurus-theme.yml

@@ -0,0 +1,41 @@
+name: CI [typedoc-docusaurus-theme]
+on:
+  push:
+    paths:
+      - 'packages/typedoc-docusaurus-theme/**'
+      - '!packages/typedoc-docusaurus-theme/README.md'
+      - '!packages/typedoc-docusaurus-theme/CHANGELOG.md'
+      - '!packages/typedoc-docusaurus-theme/package.json'
+    branches:
+      - main
+      - release
+      - beta
+  pull_request:
+    paths:
+      - 'packages/typedoc-docusaurus-theme/**'
+      - '!packages/typedoc-docusaurus-theme/README.md'
+      - '!packages/typedoc-docusaurus-theme/CHANGELOG.md'
+      - '!packages/typedoc-docusaurus-theme/package.json'
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: ['18']
+    name: Node ${{ matrix.node }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+          cache: 'npm'
+      - name: Install
+        run: HUSKY=0 npm ci
+      - name: Lint
+        run: npm run lint --workspace typedoc-docusaurus-theme
+      - name: Build
+        run: npm run build --workspace typedoc-plugin-markdown --workspace typedoc-docusaurus-theme
+      - name: Test
+        run: npm run test --workspace typedoc-docusaurus-theme

.github/workflows/ci.typedoc-github-wiki-theme.yml

@@ -32,7 +32,7 @@ jobs:
           node-version: ${{ matrix.node }}
           cache: 'npm'
       - name: Install
-        run: HUSKY=0 npm install
+        run: HUSKY=0 npm ci
       - name: Lint
         run: npm run lint --workspace typedoc-github-wiki-theme
       - name: Build

.github/workflows/ci.typedoc-gitlab-wiki-theme.yml

@@ -32,7 +32,7 @@ jobs:
           node-version: ${{ matrix.node }}
           cache: 'npm'
       - name: Install
-        run: HUSKY=0 npm install
+        run: HUSKY=0 npm ci
       - name: Lint
         run: npm run lint --workspace typedoc-github-wiki-theme
       - name: Build

.github/workflows/ci.typedoc-plugin-frontmatter.yml

@@ -32,7 +32,7 @@ jobs:
           node-version: ${{ matrix.node }}
           cache: 'npm'
       - name: Install
-        run: HUSKY=0 npm install
+        run: HUSKY=0 npm ci
       - name: Lint
         run: npm run lint --workspace typedoc-plugin-frontmatter
       - name: Build

.github/workflows/ci.typedoc-plugin-remark.yml

@@ -32,7 +32,7 @@ jobs:
           node-version: ${{ matrix.node }}
           cache: 'npm'
       - name: Install
-        run: HUSKY=0 npm install
+        run: HUSKY=0 npm ci
       - name: Lint
         run: npm run lint --workspace typedoc-plugin-remark
       - name: Build

.github/workflows/ci.typedoc-vitepress-theme.yml

@@ -32,7 +32,7 @@ jobs:
           node-version: ${{ matrix.node }}
           cache: 'npm'
       - name: Install
-        run: HUSKY=0 npm install
+        run: HUSKY=0 npm ci
       - name: Lint
         run: npm run lint --workspace typedoc-vitepress-theme
       - name: Build

README.md

@@ -16,6 +16,7 @@ Please see [typedoc-plugin-markdown.org](https://typedoc-plugin-markdown.org).
 [typedoc-github-wiki-theme](./packages/typedoc-github-wiki-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-github-wiki-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-github-wiki-theme) | ![Downloads](https://img.shields.io/npm/dw/typedoc-github-wiki-theme?label=↓) | [Changelog](./packages/typedoc-github-wiki-theme/CHANGELOG.md) | 
 [typedoc-gitlab-wiki-theme](./packages/typedoc-gitlab-wiki-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-gitlab-wiki-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-gitlab-wiki-theme) | ![Downloads](https://img.shields.io/npm/dw/typedoc-gitlab-wiki-theme?label=↓) | [Changelog](./packages/typedoc-gitlab-wiki-theme/CHANGELOG.md) | 
 [typedoc-vitepress-theme](./packages/typedoc-vitepress-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-vitepress-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-vitepress-theme) | ![Downloads](https://img.shields.io/npm/dw/typedoc-vitepress-theme?label=↓) | [Changelog](./packages/typedoc-vitepress-theme/CHANGELOG.md) | 
+[typedoc-docusaurus-theme](./packages/typedoc-docusaurus-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-docusaurus-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-docusaurus-theme) | ![Downloads](https://img.shields.io/npm/dw/typedoc-docusaurus-theme?label=↓) | [Changelog](./packages/typedoc-docusaurus-theme/CHANGELOG.md) | 
 [docusaurus-plugin-typedoc](./packages/docusaurus-plugin-typedoc#readme) | [![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc.svg?logo=npm)](https://www.npmjs.com/package/docusaurus-plugin-typedoc) | ![Downloads](https://img.shields.io/npm/dw/docusaurus-plugin-typedoc?label=↓) | [Changelog](./packages/docusaurus-plugin-typedoc/CHANGELOG.md) | 
 
 ## Contributing