docusaurus-plugin-typedoc 0.17.4 → 0.18.0

package/README.md

@@ -101,6 +101,7 @@ Options specific to the plugin should also be declared in the same object.
 | `includeExtension`      | `true`  | Determines whether to preserve the `.md` extension in relative links. `true` is recommended as per [Docusaurus documentation](https://docusaurus.io/docs/docs-markdown-features#referencing-other-documents) |
 | `frontmatter`           | `null`  | Additional frontmatter options object. See [Frontmatter](#frontmatter).                                                                                                                                      |
 | `sidebar.categoryLabel` | `API`   | The sidebar parent category label.                                                                                                                                                                           |
+| `sidebar.collapsed`     | `true`  | Whether the parent category is initially collapsed                                                                                                                                                                     |
 | `sidebar.fullNames`     | `false` | Display full names with module path.                                                                                                                                                                         |
 | `sidebar.position`      | `auto`  | The position of the sidebar in the tree.                                                                                                                                                                     |
 
@@ -121,6 +122,7 @@ module.exports = {
         out: 'api-xyz',
         sidebar: {
           categoryLabel: 'API XYZ',
+          collapsed: false,
           position: 0,
           fullNames: true,
         },
@@ -153,7 +155,7 @@ module.exports = {
 
 2. Alternatively, if you wish to manually control other parts of your sidebar you can use a slice for the TypeDoc sidebar.
 
-> note: `sidebar.categoryLabel` and `sidebar.position` options are ignored with this implementation)
+> note: `sidebar.categoryLabel`, `sidebar.collapsed`, and `sidebar.position` options are ignored with this implementation)
 
 ```js
 module.exports = {

package/dist/options.js

@@ -9,9 +9,11 @@ const DEFAULT_PLUGIN_OPTIONS = {
     sidebar: {
         fullNames: false,
         categoryLabel: 'API',
+        collapsed: true,
         indexLabel: undefined,
         readmeLabel: 'Readme',
         position: null,
+        autoConfiguration: true,
     },
     hideInPageTOC: true,
     hideBreadcrumbs: true,

package/dist/plugin.d.ts

@@ -1,5 +1,7 @@
+import { LoadContext } from '@docusaurus/types';
 import { PluginOptions } from './types';
-export default function pluginDocusaurus(context: any, opts: Partial<PluginOptions>): {
+export default function pluginDocusaurus(context: LoadContext, opts: Partial<PluginOptions>): {
     name: string;
     loadContent(): Promise<void>;
+    extendCli(cli: any): void;
 };

package/dist/plugin.js

@@ -36,30 +36,46 @@ function pluginDocusaurus(context, opts) {
         async loadContent() {
             if (opts.id && !apps.includes(opts.id)) {
                 apps.push(opts.id);
-                const { siteDir } = context;
-                const options = (0, options_1.getPluginOptions)(opts);
-                const outputDir = path.resolve(siteDir, options.docsRoot, options.out);
-                if (opts.cleanOutputDir) {
-                    (0, render_1.removeDir)(outputDir);
-                }
-                const app = new typedoc_1.Application();
-                app.renderer.defineTheme('docusaurus', theme_1.DocusaurusTheme);
-                (0, typedoc_plugin_markdown_1.load)(app);
-                (0, render_1.bootstrap)(app, options);
-                const project = app.convert();
-                if (!project) {
-                    return;
-                }
-                if (options.watch) {
-                    app.convertAndWatch(async (project) => {
-                        await app.generateDocs(project, outputDir);
-                    });
-                }
-                else {
-                    await app.generateDocs(project, outputDir);
-                }
+                generateTypedoc(context, opts);
             }
         },
+        extendCli(cli) {
+            cli
+                .command('generate-typedoc')
+                .description('(docusaurus-plugin-typedoc) Generate TypeDoc docs independently of the Docusaurus build process.')
+                .action(async () => {
+                var _a;
+                (_a = context.siteConfig) === null || _a === void 0 ? void 0 : _a.plugins.forEach((pluginConfig) => {
+                    if (pluginConfig && typeof pluginConfig[1] === 'object') {
+                        generateTypedoc(context, pluginConfig[1]);
+                    }
+                });
+            });
+        },
     };
 }
 exports.default = pluginDocusaurus;
+async function generateTypedoc(context, opts) {
+    const { siteDir } = context;
+    const options = (0, options_1.getPluginOptions)(opts);
+    const outputDir = path.resolve(siteDir, options.docsRoot, options.out);
+    if (opts.cleanOutputDir) {
+        (0, render_1.removeDir)(outputDir);
+    }
+    const app = new typedoc_1.Application();
+    app.renderer.defineTheme('docusaurus', theme_1.DocusaurusTheme);
+    (0, typedoc_plugin_markdown_1.load)(app);
+    (0, render_1.bootstrap)(app, options);
+    const project = app.convert();
+    if (!project) {
+        return;
+    }
+    if (options.watch) {
+        app.convertAndWatch(async (project) => {
+            await app.generateDocs(project, outputDir);
+        });
+    }
+    else {
+        await app.generateDocs(project, outputDir);
+    }
+}

package/dist/theme.d.ts

@@ -16,7 +16,6 @@ export declare class DocusaurusTheme extends MarkdownTheme {
     getSidebarPosition(page: PageEvent<DeclarationReflection>): "0.5" | "0" | null;
     getId(page: PageEvent): string;
     getTitle(page: PageEvent): any;
-    getSlug(): string;
     get mappings(): {
         kind: ReflectionKind[];
         isLeaf: boolean;

package/dist/theme.js

@@ -30,11 +30,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocusaurusTheme = void 0;
-const typedoc_1 = require("typedoc");
 const fs = __importStar(require("fs"));
-const theme_1 = require("typedoc-plugin-markdown/dist/theme");
-const groups_1 = require("typedoc-plugin-markdown/dist/groups");
 const path = __importStar(require("path"));
+const typedoc_1 = require("typedoc");
+const groups_1 = require("typedoc-plugin-markdown/dist/groups");
+const theme_1 = require("typedoc-plugin-markdown/dist/theme");
 const front_matter_1 = require("typedoc-plugin-markdown/dist/utils/front-matter");
 const CATEGORY_POSITION = {
     [typedoc_1.ReflectionKind.Module]: 1,
@@ -69,14 +69,16 @@ class DocusaurusTheme extends theme_1.MarkdownTheme {
         }
     }
     onRendererEnd(renderer) {
-        writeCategoryYaml(renderer.outputDirectory, this.sidebar.categoryLabel, this.sidebar.position);
-        Object.keys(groupUrlsByKind(this.getUrls(renderer.project))).forEach((group) => {
-            const kind = parseInt(group);
-            const mapping = this.mappings.find((mapping) => mapping.kind.includes(kind));
-            if (mapping) {
-                writeCategoryYaml(renderer.outputDirectory + '/' + mapping.directory, (0, groups_1.getKindPlural)(kind), CATEGORY_POSITION[kind]);
-            }
-        });
+        if (this.sidebar.autoConfiguration) {
+            writeCategoryYaml(renderer.outputDirectory, this.sidebar.categoryLabel, this.sidebar.position, this.sidebar.collapsed);
+            Object.keys(groupUrlsByKind(this.getUrls(renderer.project))).forEach((group) => {
+                const kind = parseInt(group);
+                const mapping = this.mappings.find((mapping) => mapping.kind.includes(kind));
+                if (mapping) {
+                    writeCategoryYaml(renderer.outputDirectory + '/' + mapping.directory, (0, groups_1.getKindPlural)(kind), CATEGORY_POSITION[kind], true);
+                }
+            });
+        }
     }
     getYamlItems(page) {
         const pageId = this.getId(page);
@@ -87,14 +89,16 @@ class DocusaurusTheme extends theme_1.MarkdownTheme {
             id: pageId,
             title: pageTitle,
         };
-        if (page.url === this.entryDocument) {
-            items = { ...items, slug: this.getSlug() };
-        }
-        if (sidebarLabel && sidebarLabel !== pageTitle) {
-            items = { ...items, sidebar_label: sidebarLabel };
+        if (page.url === this.entryDocument && this.indexSlug) {
+            items = { ...items, slug: this.indexSlug };
         }
-        if (sidebarPosition) {
-            items = { ...items, sidebar_position: parseFloat(sidebarPosition) };
+        if (this.sidebar.autoConfiguration) {
+            if (sidebarLabel && sidebarLabel !== pageTitle) {
+                items = { ...items, sidebar_label: sidebarLabel };
+            }
+            if (sidebarPosition) {
+                items = { ...items, sidebar_position: parseFloat(sidebarPosition) };
+            }
         }
         if (page.url === page.project.url && this.entryPoints.length > 1) {
             items = { ...items, hide_table_of_contents: true };
@@ -109,7 +113,7 @@ class DocusaurusTheme extends theme_1.MarkdownTheme {
     }
     getSidebarLabel(page) {
         const indexLabel = this.sidebar.indexLabel ||
-            (this.entryPoints.length > 1 ? 'Table of contents' : 'Exports');
+            (this.entryPoints.length > 1 ? 'Table of Contents' : 'Exports');
         if (page.url === this.entryDocument) {
             return page.url === page.project.url
                 ? indexLabel
@@ -142,15 +146,6 @@ class DocusaurusTheme extends theme_1.MarkdownTheme {
         }
         return (0, front_matter_1.getPageTitle)(page);
     }
-    getSlug() {
-        if (this.indexSlug) {
-            return this.indexSlug;
-        }
-        if (this.out === process.cwd()) {
-            return '/';
-        }
-        return `/${path.relative(process.cwd(), this.out).replace(/\\/g, '/')}/`;
-    }
     get mappings() {
         return super.mappings.map((mapping) => {
             if (mapping.kind.includes(typedoc_1.ReflectionKind.Namespace)) {
@@ -182,11 +177,14 @@ __decorate([
     (0, typedoc_1.BindOption)('frontmatter')
 ], DocusaurusTheme.prototype, "frontmatter", void 0);
 exports.DocusaurusTheme = DocusaurusTheme;
-const writeCategoryYaml = (categoryPath, label, position) => {
+const writeCategoryYaml = (categoryPath, label, position, collapsed) => {
     const yaml = [`label: "${label}"`];
     if (position !== null) {
         yaml.push(`position: ${position}`);
     }
+    if (!collapsed) {
+        yaml.push(`collapsed: false`);
+    }
     if (fs.existsSync(categoryPath)) {
         fs.writeFileSync(categoryPath + '/_category_.yml', yaml.join('\n'));
     }

package/dist/types.d.ts

@@ -21,17 +21,19 @@ export interface PluginOptions {
     theme?: string;
     frontmatter: FrontMatter;
 }
-export declare type FrontMatter = Record<string, string | boolean | number | null> | undefined;
+export type FrontMatter = Record<string, string | boolean | number | null> | undefined;
 export interface SidebarOptions {
     fullNames?: boolean;
     categoryLabel: string;
+    collapsed: boolean;
     indexLabel?: string;
     readmeLabel?: string;
     position: number | null;
+    autoConfiguration: boolean;
 }
 export interface SidebarCategory {
     type: string;
     label: string;
     items: SidebarItem[];
 }
-export declare type SidebarItem = SidebarCategory | string;
+export type SidebarItem = SidebarCategory | string;

package/package.json

@@ -1,43 +1,42 @@
-{
-  "name": "docusaurus-plugin-typedoc",
-  "version": "0.17.4",
-  "description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.",
-  "main": "dist/index.js",
-  "files": [
-    "dist/"
-  ],
-  "bugs": {
-    "url": "https://github.com/tgreyuk/typedoc-plugin-markdown/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/tgreyuk/typedoc-plugin-markdown.git",
-    "directory": "packages/docusaurus-plugin-typedoc"
-  },
-  "homepage": "https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc",
-  "peerDependencies": {
-    "typedoc": ">=0.22.0",
-    "typedoc-plugin-markdown": ">=3.11.10"
-  },
-  "scripts": {
-    "lint": "eslint ./src --ext .ts",
-    "prepublishOnly": "yarn run lint && yarn run build && yarn run test",
-    "build": "rimraf ./dist && tsc",
-    "build-and-test": "yarn run build && yarn run test",
-    "test:init": "rimraf test/site && npx create-docusaurus@latest test/site classic",
-    "test:demo:start": "yarn run build && cd test/site && yarn run start",
-    "test:demo:build": "yarn run build && cd test/site && yarn run build && yarn run serve",
-    "test": "jest --colors"
-  },
-  "author": "Thomas Grey",
-  "license": "MIT",
-  "keywords": [
-    "docusaurus",
-    "typedoc",
-    "plugin",
-    "markdown",
-    "typescript",
-    "api"
-  ],
-  "gitHead": "57c7498a9c3d2a82e803ed98f905258b25f4f4eb"
-}
+{
+  "name": "docusaurus-plugin-typedoc",
+  "version": "0.18.0",
+  "description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.",
+  "main": "dist/index.js",
+  "files": [
+    "dist/"
+  ],
+  "bugs": {
+    "url": "https://github.com/tgreyuk/typedoc-plugin-markdown/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tgreyuk/typedoc-plugin-markdown.git",
+    "directory": "packages/docusaurus-plugin-typedoc"
+  },
+  "homepage": "https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc",
+  "peerDependencies": {
+    "typedoc": ">=0.23.0",
+    "typedoc-plugin-markdown": ">=3.13.0"
+  },
+  "devDependencies": {
+    "typedoc-plugin-markdown": "^3.13.0"
+  },
+  "scripts": {
+    "lint": "eslint ./src --ext .ts",
+    "prepublishOnly": "yarn run lint && yarn run build && yarn run test",
+    "build": "rm -rf ./dist && tsc",
+    "build-and-test": "yarn run build && yarn run test",
+    "test": "jest --colors"
+  },
+  "author": "Thomas Grey",
+  "license": "MIT",
+  "keywords": [
+    "docusaurus",
+    "typedoc",
+    "plugin",
+    "markdown",
+    "typescript",
+    "api"
+  ]
+}