.github/workflows/ci.yml

@@ -18,11 +18,11 @@ jobs:
         run: yarn install
       - name: Install
         run: yarn
-      - name: Lint
-        run: yarn run lint
+      - name: Lint Code
+        run: yarn run lint:code
       - name: Build
         run: yarn run build
-      - name: Markdownlint
-        run: yarn run markdownlint
-      #- name: Test
-      # run: yarn test
+      - name: Lint Markdown
+        run: yarn run lint:md
+      - name: Test
+        run: yarn test

examples/docusaurus/docusaurus.config.js

@@ -1,9 +1,19 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
+const path = require('path');
 
 const lightCodeTheme = require('prism-react-renderer/themes/github');
 const darkCodeTheme = require('prism-react-renderer/themes/dracula');
 
+const docusaurusPlugin = path.join(
+  __dirname,
+  '..',
+  '..',
+  'packages',
+  'docusaurus-plugin-typedoc',
+  'dist',
+);
+
 /** @type {import('@docusaurus/types').Config} */
 const config = {
   title: 'My Site',
@@ -29,14 +39,15 @@ const config = {
   // Additional plugins
   plugins: [
     [
-      'docusaurus-plugin-typedoc',
+      docusaurusPlugin,
       {
         entryPoints: ['../../stub-project/src/index.ts'],
         tsconfig: '../../stub-project/tsconfig.json',
         plugin: ['typedoc-plugin-mdn-links'],
         sidebar: {
           autoConfiguration: true,
           position: 0,
+          indexLabel: 'Custom Index Label',
         },
         cleanOutputDir: true,
       },

examples/docusaurus/package.json

@@ -4,6 +4,7 @@
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
+    "prestart": "cd ../../packages/docusaurus-plugin-typedoc && npm run build",
     "start": "docusaurus start",
     "build": "docusaurus build",
     "swizzle": "docusaurus swizzle",

examples/docusaurus/sidebars.js

@@ -14,18 +14,7 @@
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
 const sidebars = {
   // By default, Docusaurus generates a sidebar from the docs folder structure
-  tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
-
-  // But you can create a sidebar manually
-  /*
-  tutorialSidebar: [
-    {
-      type: 'category',
-      label: 'Tutorial',
-      items: ['hello'],
-    },
-  ],
-   */
+  sidebar: [{ type: 'autogenerated', dirName: '.' }],
 };
 
 module.exports = sidebars;

examples/docusaurus/typedoc.json

@@ -0,0 +1,3 @@
+{
+  "name": "project-name"
+}