Merge pull request #167 from universal-ember/copy-comparison-table

Add detail from #166

Author: NullVoxPopuli

docs/package.json

@@ -5,10 +5,11 @@
   "scripts": {
     "start": "pnpm docs:watch",
     "debug": "npx html-pages ./dist --no-cache",
-    "docs:collect": "typedoc --options ./typedoc.config.json",
-    "docs:watch": "typedoc --options ./typedoc.config.json --watch"
+    "docs:collect": "typedoc --options ./typedoc.config.mjs",
+    "docs:watch": "typedoc --options ./typedoc.config.mjs --watch"
   },
   "devDependencies": {
+    "markdown-it-footnote": "^4.0.0",
     "typedoc": "^0.28.7",
     "typedoc-github-theme": "^0.3.0",
     "typedoc-github-wiki-theme": "^2.1.0",

docs/typedoc.config.json

@@ -0,0 +1,48 @@
+import { createRequire } from 'node:module';
+
+const require = createRequire(import.meta.url);
+
+const footnotes = require('markdown-it-footnote');
+
+export default {
+  tsconfig: '../reactiveweb/tsconfig.json',
+  markdownItLoader(parser) {
+    parser.use(footnotes);
+  },
+  cleanOutputDir: true,
+  compilerOptions: {
+    noEmitOnError: false,
+  },
+  entryPoints: [
+    '../reactiveweb/src/*',
+    '../reactiveweb/src/resource/service.ts',
+    '../reactiveweb/src/resource/modifier/index.ts',
+  ],
+  navigationLinks: {
+    GitHub: 'https://github.com/universal-ember/reactiveweb',
+  },
+  readme: './README.md',
+  exclude: ['../reactiveweb/src/get-promise-state.typetest.ts'],
+  out: 'dist',
+  emit: 'docs',
+  pretty: true,
+  skipErrorChecking: true,
+  highlightLanguages: [
+    'bash',
+    'css',
+    'html',
+    'javascript',
+    'typescript',
+    'glimmer-js',
+    'glimmer-ts',
+    'json',
+    'jsonc',
+  ],
+  excludePrivate: true,
+  excludeProtected: false,
+  excludeExternals: true,
+  searchInComments: true,
+  disableSources: false,
+  categorizeByGroup: false,
+  plugin: ['typedoc-github-theme'],
+};