docusaurus-plugin-typedoc 1.0.0-next.0 → 1.0.0-next.2

package/README.md

@@ -95,14 +95,12 @@ TypeDoc options can also be declared:
 
 Options specific to the plugin should also be declared in the same object.
 
-| Name                    | Default | Description                                                                                                                                                                                                  |
-| :---------------------- | :------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `out`                   | `"api"` | Output dir relative to docs dir (use `.` for no subdir).                                                                                                                                                     |
-| `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.fullNames`     | `false` | Display full names with module path.                                                                                                                                                                         |
-| `sidebar.position`      | `auto`  | The position of the sidebar in the tree.                                                                                                                                                                     |
+| Name                    | Default | Description                                              |
+| :---------------------- | :------ | :------------------------------------------------------- |
+| `out`                   | `"api"` | Output dir relative to docs dir (use `.` for no subdir). |
+| `sidebar.categoryLabel` | `API`   | The sidebar parent category label.                       |
+| `sidebar.fullNames`     | `false` | Display full names with module path.                     |
+| `sidebar.position`      | `auto`  | The position of the sidebar in the tree.                 |
 
 ### An example configuration
 
@@ -195,7 +193,7 @@ Please see https://docusaurus.io/docs/api/themes/configuration#navbar-items for
 ### Frontmatter
 
 By default the plugin will configure minimal required [Frontmatter](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter) configuration.
-Additionally required global Frontmatter options can be passed in using the `frontmatter` options object
+Additionally required global Frontmatter options can be passed in using the `frontmatterGlobals` options object
 
 `docusaurus.config.js`:
 
@@ -205,7 +203,7 @@ plugins: [
       'docusaurus-plugin-typedoc',
       {
       // .... other plugin option
-      frontmatter: {
+      frontmatterGlobals: {
         pagination_prev: null,
         pagination_next: null
       }

package/dist/options.js

@@ -10,8 +10,7 @@ const DEFAULT_PLUGIN_OPTIONS = {
         fullNames: false,
         categoryLabel: 'API',
         collapsed: true,
-        indexLabel: undefined,
-        readmeLabel: 'Readme',
+        indexLabel: 'Overview',
         position: null,
         autoConfiguration: true,
     },
@@ -21,10 +20,8 @@ const DEFAULT_PLUGIN_OPTIONS = {
     entryDocument: 'index.md',
     plugin: ['none'],
     watch: false,
-    includeExtension: true,
-    indexSlug: undefined,
     theme: 'docusaurus',
-    frontmatter: undefined,
+    enableFrontmatter: true,
 };
 const getPluginOptions = (opts) => {
     const options = {

package/dist/render.js

@@ -66,23 +66,10 @@ const addTypedocDeclarations = (app) => {
     app.options.addDeclaration({
         name: 'globalsTitle',
     });
-    app.options.addDeclaration({
-        name: 'readmeTitle',
-    });
-    app.options.addDeclaration({
-        name: 'indexSlug',
-    });
-    app.options.addDeclaration({
-        name: 'includeExtension',
-    });
     app.options.addDeclaration({
         name: 'sidebar',
         type: typedoc_1.ParameterType.Mixed,
     });
-    app.options.addDeclaration({
-        name: 'frontmatter',
-        type: typedoc_1.ParameterType.Mixed,
-    });
 };
 function removeDir(path) {
     fs.rmSync(path, { recursive: true, force: true });

package/dist/theme-context.d.ts

@@ -0,0 +1,11 @@
+import { DeclarationReflection, PageEvent, Reflection } from 'typedoc';
+import { MarkdownThemeRenderContext } from 'typedoc-plugin-markdown';
+export declare class DocusaurusThemeRenderContext extends MarkdownThemeRenderContext {
+    baseFrontmatterVars: (page: PageEvent<Reflection>) => {
+        sidebar_position?: number | undefined;
+        sidebar_label?: string | undefined;
+        title: string;
+    };
+    getSidebarLabel(page: PageEvent<DeclarationReflection>): string | null | undefined;
+    getSidebarPosition(page: PageEvent<DeclarationReflection>): "0.5" | "0" | null;
+}

package/dist/theme-context.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocusaurusThemeRenderContext = void 0;
+const typedoc_plugin_markdown_1 = require("typedoc-plugin-markdown");
+class DocusaurusThemeRenderContext extends typedoc_plugin_markdown_1.MarkdownThemeRenderContext {
+    constructor() {
+        super(...arguments);
+        this.baseFrontmatterVars = (page) => {
+            const sidebarPosition = parseFloat(this.getSidebarPosition(page));
+            const sidebarLabel = this.getSidebarLabel(page);
+            return {
+                ...this.getBaseFrontmatterVars(page),
+                ...(this.options.getValue('sidebar').autoConfiguration
+                    ? {
+                        ...(sidebarLabel && { sidebar_label: sidebarLabel }),
+                        ...(sidebarPosition && {
+                            sidebar_position: sidebarPosition,
+                        }),
+                    }
+                    : {}),
+            };
+        };
+    }
+    getSidebarLabel(page) {
+        if (page.url === this.options.getValue('entryDocument')) {
+            return this.options.getValue('sidebar').indexLabel;
+        }
+        return null;
+    }
+    getSidebarPosition(page) {
+        if (page.url === this.options.getValue('entryDocument')) {
+            return page.url === page.project.url ? '0.5' : '0';
+        }
+        if (page.url === this.globalsFile) {
+            return '0.5';
+        }
+        if (page.model.getFullName().split('.').length === 1) {
+            return '0';
+        }
+        return null;
+    }
+}
+exports.DocusaurusThemeRenderContext = DocusaurusThemeRenderContext;

package/dist/theme.d.ts

@@ -1,19 +1,13 @@
 import { DeclarationReflection, PageEvent, Renderer, RendererEvent } from 'typedoc';
 import { MarkdownTheme } from 'typedoc-plugin-markdown';
-import { FrontMatter, SidebarOptions } from './types';
+import { SidebarOptions } from './types';
 export declare class DocusaurusTheme extends MarkdownTheme {
     sidebar: SidebarOptions;
-    readmeTitle: string;
-    indexSlug: string;
-    includeExtension: string;
-    frontmatter: FrontMatter;
+    private _contextCache?;
     constructor(renderer: Renderer);
+    getRenderContext(): any;
     onPageEnd(page: PageEvent<DeclarationReflection>): void;
     onRendererEnd(renderer: RendererEvent): void;
     loopAndWriteCategories(path: string): void;
     writeCategoryYaml: (categoryPath: string, label: string, position: number | null, collapsed: boolean) => void;
-    getYamlItems(page: PageEvent<DeclarationReflection>): FrontMatter;
-    getSidebarLabel(page: PageEvent<DeclarationReflection>): string | undefined;
-    getSidebarPosition(page: PageEvent<DeclarationReflection>): "0.5" | "0" | null;
-    get globalsFile(): string;
 }

package/dist/theme.js

@@ -33,8 +33,8 @@ exports.DocusaurusTheme = void 0;
 const fs = __importStar(require("fs"));
 const typedoc_1 = require("typedoc");
 const typedoc_plugin_markdown_1 = require("typedoc-plugin-markdown");
-const front_matter_1 = require("./front-matter");
 const navigation_1 = require("./navigation");
+const theme_context_1 = require("./theme-context");
 class DocusaurusTheme extends typedoc_plugin_markdown_1.MarkdownTheme {
     constructor(renderer) {
         super(renderer);
@@ -55,9 +55,13 @@ class DocusaurusTheme extends typedoc_plugin_markdown_1.MarkdownTheme {
             [typedoc_1.RendererEvent.END]: this.onRendererEnd,
         });
     }
+    getRenderContext() {
+        this._contextCache || (this._contextCache = new theme_context_1.DocusaurusThemeRenderContext(this, this.application.options));
+        return this._contextCache;
+    }
     onPageEnd(page) {
         if (page.contents) {
-            page.contents = (0, front_matter_1.prependYAML)(page.contents.replace(/\\</g, '<'), this.getYamlItems(page));
+            page.contents = page.contents.replace(/\\</g, '<');
         }
     }
     onRendererEnd(renderer) {
@@ -77,81 +81,17 @@ class DocusaurusTheme extends typedoc_plugin_markdown_1.MarkdownTheme {
                     return entry[1].directory === segment;
                 })
                     .map((entry) => entry[1])[0];
-                if (mapping) {
+                const subdirectory = fs.readdirSync(fullPath);
+                const containsDir = subdirectory.some((item) => fs.lstatSync(`${fullPath}/${item}`).isDirectory());
+                if (mapping && !containsDir) {
                     this.writeCategoryYaml(fullPath, (0, navigation_1.getKindPlural)(mapping.kind), navigation_1.CATEGORY_POSITION[mapping.kind], true);
                 }
                 this.loopAndWriteCategories(fullPath);
             }
         });
     }
-    getYamlItems(page) {
-        const sidebarLabel = this.getSidebarLabel(page);
-        const sidebarPosition = this.getSidebarPosition(page);
-        let items = {};
-        if (page.url === this.entryDocument && this.indexSlug) {
-            items = { ...items, slug: this.indexSlug };
-        }
-        if (this.sidebar.autoConfiguration) {
-            if (sidebarLabel) {
-                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 };
-        }
-        items = { ...items, custom_edit_url: null };
-        if (this.frontmatter) {
-            items = { ...items, ...this.frontmatter };
-        }
-        return {
-            ...items,
-        };
-    }
-    getSidebarLabel(page) {
-        const indexLabel = this.sidebar.indexLabel ||
-            (this.entryPoints.length > 1 ? 'Table of Contents' : 'Exports');
-        if (page.url === this.entryDocument) {
-            return page.url === page.project.url
-                ? indexLabel
-                : this.sidebar.readmeLabel;
-        }
-        if (page.url === this.globalsFile) {
-            return indexLabel;
-        }
-        return this.sidebar.fullNames ? page.model.getFullName() : page.model.name;
-    }
-    getSidebarPosition(page) {
-        if (page.url === this.entryDocument) {
-            return page.url === page.project.url ? '0.5' : '0';
-        }
-        if (page.url === this.globalsFile) {
-            return '0.5';
-        }
-        if (page.model.getFullName().split('.').length === 1) {
-            return '0';
-        }
-        return null;
-    }
-    get globalsFile() {
-        return 'modules.md';
-    }
 }
 __decorate([
     (0, typedoc_1.BindOption)('sidebar')
 ], DocusaurusTheme.prototype, "sidebar", void 0);
-__decorate([
-    (0, typedoc_1.BindOption)('readmeTitle')
-], DocusaurusTheme.prototype, "readmeTitle", void 0);
-__decorate([
-    (0, typedoc_1.BindOption)('indexSlug')
-], DocusaurusTheme.prototype, "indexSlug", void 0);
-__decorate([
-    (0, typedoc_1.BindOption)('includeExtension')
-], DocusaurusTheme.prototype, "includeExtension", void 0);
-__decorate([
-    (0, typedoc_1.BindOption)('frontmatter')
-], DocusaurusTheme.prototype, "frontmatter", void 0);
 exports.DocusaurusTheme = DocusaurusTheme;

package/dist/types.d.ts

@@ -16,9 +16,8 @@ export interface PluginOptions {
     hidePageTitle: boolean;
     entryDocument: string;
     includeExtension?: boolean;
-    indexSlug?: string;
     theme?: string;
-    frontmatter: FrontMatter;
+    enableFrontmatter: boolean;
 }
 export type FrontMatter = Record<string, string | boolean | number | null> | undefined;
 export interface SidebarOptions {
@@ -26,7 +25,6 @@ export interface SidebarOptions {
     categoryLabel: string;
     collapsed: boolean;
     indexLabel?: string;
-    readmeLabel?: string;
     position: number | null;
     autoConfiguration: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "1.0.0-next.0",
+  "version": "1.0.0-next.2",
   "description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.",
   "main": "dist/index.js",
   "files": [
@@ -17,7 +17,7 @@
   "homepage": "https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc",
   "peerDependencies": {
     "typedoc": ">=0.23.0",
-    "typedoc-plugin-markdown": ">=4.0.0-next.0"
+    "typedoc-plugin-markdown": ">=4.0.0-next.2"
   },
   "scripts": {
     "lint": "eslint ./src --ext .ts",

package/dist/front-matter.d.ts

@@ -1,4 +0,0 @@
-export interface FrontMatterVars {
-    [key: string]: string | number | boolean;
-}
-export declare const prependYAML: (contents: string, vars: FrontMatterVars) => string;

package/dist/front-matter.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.prependYAML = void 0;
-const prependYAML = (contents, vars) => {
-    return contents
-        .replace(/^/, toYAML(vars) + '\n\n')
-        .replace(/[\r\n]{3,}/g, '\n\n');
-};
-exports.prependYAML = prependYAML;
-const toYAML = (vars) => {
-    const yaml = `---
-${Object.entries(vars)
-        .map(([key, value]) => `${key}: ${typeof value === 'string' ? `"${escapeString(value)}"` : value}`)
-        .join('\n')}
----`;
-    return yaml;
-};
-const escapeString = (str) => str.replace(/"/g, '\\"');