chore: Refactor theme context

typedoc2md · Mar 16, 2024 · 0e213c7 · 0e213c7
1 parent 270ba16
commit 0e213c7
Show file tree

Hide file tree

Showing 173 changed files with 3,524 additions and 2,374 deletions.
diff --git a/devtools/examples/docusaurus3/docusaurus.config.js b/devtools/examples/docusaurus3/docusaurus.config.js
@@ -60,7 +60,6 @@ const config = {
         sidebar: { pretty: true },
         outputFileStrategy: 'members',
         cleanOutputDir: true,
-        plugin: ['typedoc-plugin-coverage'],
       },
     ],
     [
@@ -77,7 +76,6 @@ const config = {
         entryPoints:
           '../../../packages/typedoc-plugin-markdown/test/fixtures/src/groups/**/*.ts',
         cleanOutputDir: true,
-        plugin: ['typedoc-plugin-coverage'],
       },
     ],
     [
@@ -97,7 +95,6 @@ const config = {
         outputFileStrategy: 'modules',
         entryModule: 'index',
         cleanOutputDir: true,
-        plugin: ['typedoc-plugin-coverage'],
       },
     ],
     [
@@ -115,7 +112,6 @@ const config = {
           '../../../packages/typedoc-plugin-markdown/test/fixtures/src/packages/*',
         entryPointStrategy: 'packages',
         sidebar: { pretty: true },
-        plugin: ['typedoc-plugin-coverage'],
       },
     ],
   ],

diff --git a/devtools/packages/helpers/constants.ts b/devtools/packages/helpers/constants.ts
@@ -4,8 +4,8 @@ export const PRESETS_PATH = `${process.cwd()}/src/options/presets.ts`;
 
 export const DOCS_CONFIG: Record<string, DocsConfig> = {
   ['typedoc-plugin-markdown']: {
-    declarationsPath: `${process.cwd()}/src/plugin/options/declarations.ts`,
-    optionsPath: 'options',
+    declarationsPath: `${process.cwd()}/src/app/options/declarations.ts`,
+    optionsPath: '',
     docsPath: '',
     declarations: true,
     presets: false,
@@ -27,7 +27,7 @@ export const DOCS_CONFIG: Record<string, DocsConfig> = {
   ['typedoc-github-wiki-theme']: {
     declarationsPath: `${process.cwd()}/src/options/declarations.ts`,
     optionsPath: 'themes/github-wiki',
-    docsPath: '/themes/github-wiki/introduction',
+    docsPath: '/themes/github-wiki',
     declarations: true,
     presets: true,
   },

diff --git a/devtools/packages/prebuild-options/tasks/generate-docs.ts b/devtools/packages/prebuild-options/tasks/generate-docs.ts
@@ -146,7 +146,7 @@ ${JSON.stringify(
   }
 
   const optionDocPath = path.join(
-    getDocsPath(docsConfig.docsPath),
+    getDocsPath(docsConfig.optionsPath),
     'options.mdx',
   );
 

diff --git a/devtools/packages/testing/lint.mdx.mjs b/devtools/packages/testing/lint.mdx.mjs
@@ -16,7 +16,7 @@ lintMdx();
 
 async function lintMdx() {
   const mdFiles = await glob(`./test/out/**/opts-1/**/*.md`);
-  console.log(mdFiles);
+
   mdFiles.forEach(async (file) => {
     const vfile = await read(file);
     try {

diff --git a/docs/pages/_meta.json b/docs/pages/_meta.json
@@ -1,5 +1,6 @@
 {
   "index": "Introduction",
+  "api": "",
   "quick-start": "",
   "options": "",
   "guide": "Guide",

diff --git a/docs/pages/helpers.md b/docs/pages/helpers.md
diff --git a/docs/pages/options.mdx b/docs/pages/options.mdx
@@ -565,6 +565,26 @@ If undefined all urls will be relative.
 
 ___
 
+### preserveMarkup
+
+<Callout>Preserves non-html markup tags in comments.</Callout>
+
+> Accepts a boolean value. Defaults to `false`.
+
+By default non html tags inside comments are escaped.
+
+This option should be used when parsers require the preservation of non-html tags, for example if some custom JSX tags are required to be interpreted in final output.
+
+
+```json filename="typedoc.json"
+{
+  "preserveMarkup": false
+}
+
+```
+
+___
+
 ### preserveAnchorCasing
 
 <Callout>Preserve anchor casing when generating link to symbols.</Callout>

diff --git a/docs/styles.css b/docs/styles.css
@@ -1,4 +1,6 @@
 .nextra-toc a[href^='#parameters'],
-.nextra-toc a[href^='#returns'] {
+.nextra-toc a[href^='#returns'],
+.nextra-toc a[href^='#source'],
+.nextra-toc a[href^='#overrides'] {
   display: none;
 }