feat(core): exposed new option "navigationJson"

Author: tgreyuk

.changeset/beige-deer-sleep.md

@@ -0,0 +1,5 @@
+---
+'typedoc-plugin-markdown': patch
+---
+
+- Exposed new option `navigationJson` that can be used to write navigation structure as JSON to disk.

docs/content/docs/options/utility.mdx

@@ -206,6 +206,8 @@ Use the `pretty` option flag to pretty-format the JSON output.
 
 You can further configure the structure itself using the <OptionLink type="output" name="navigation" /> output option.
 
+Note the path is resolved according to the config directory.
+
 ```json filename="typedoc.json"
 {
   "navigationJson": "./path/to/navigation.json"

packages/typedoc-plugin-markdown/src/options/declarations.ts

@@ -840,6 +840,8 @@ export const navigationModel: Partial<DeclarationOption> = {
  *
  * You can further configure the structure itself using the <OptionLink type="output" name="navigation" /> output option.
  *
+ * Note the path is resolved according to the config directory.
+ *
  * @example "./path/to/navigation.json"
  *
  * @category Utility

packages/typedoc-plugin-markdown/test/fixtures/configs/navigation.cjs

@@ -8,7 +8,7 @@ const commonOptions = {
     '../src/navigation/module-2/index.ts',
     '../src/navigation/module-3/index.ts',
   ],
-  plugin: ['../../../dist/index.js', '../custom-plugins/navigation-plugin.mjs'],
+  plugin: ['../../../dist/index.js'],
   hidePageHeader: true,
   readme: 'none',
 };
@@ -40,13 +40,17 @@ module.exports = {
       name: 'markdown',
       path: '../out/md/navigation/members/opts-1',
       options: {
+        navigationJson:
+          './test/fixtures/out/md/navigation/members/opts-1/sidebar.json',
         ...opts1,
       },
     },
     {
       name: 'markdown',
       path: '../out/md/navigation/members/opts-2',
       options: {
+        navigationJson:
+          './test/fixtures/out/md/navigation/members/opts-2/sidebar.json',
         ...opts2,
       },
     },
@@ -55,6 +59,9 @@ module.exports = {
       path: '../out/md/navigation/modules/opts-1',
       options: {
         router: 'module',
+        navigationJson:
+          './test/fixtures/out/md/navigation/modules/opts-1/sidebar.json',
+
         ...opts1,
       },
     },
@@ -63,6 +70,8 @@ module.exports = {
       path: '../out/md/navigation/modules/opts-2',
       options: {
         router: 'module',
+        navigationJson:
+          './test/fixtures/out/md/navigation/modules/opts-2/sidebar.json',
         ...opts2,
       },
     },

packages/typedoc-plugin-markdown/test/scripts/build-fixtures.mjs

@@ -25,7 +25,7 @@ async function main() {
     path.join(__dirname, '..', 'fixtures', 'configs'),
   );
 
-  const devConfigs = ['customize.cjs'];
+  const devConfigs = ['reflections.cjs'];
 
   const typedocConfigs = isDev ? devConfigs : allConfigs;