docusaurus-plugin-typedoc 0.16.4 → 0.16.5

package/README.md

@@ -11,24 +11,12 @@ Generates static TypeDoc pages in Markdown with frontmatter as part of the Docus
 
 ## Installation
 
-1. Install Docusaurus in the root of your project. See https://v2.docusaurus.io/docs/installation.
-
-2. Install the plugin dependencies in the same location as the Docusaurus website directory.
+> Install [Docusaurus](https://v2.docusaurus.io/docs/installation) in the root of your project and install the plugin dependencies in the same location as the Docusaurus website directory.
 
 ```shell
-cd docs-website
 npm install typedoc typedoc-plugin-markdown docusaurus-plugin-typedoc --save-dev
 ```
 
-```
-├──docs-website (docusaurus location)
-   ├── package.json
-├──package.json
-├──src (typescript source files)
-├──tsconfig.json
-
-```
-
 ## Usage
 
 ### Config
@@ -58,16 +46,21 @@ TypeDoc will be bootstraped with the Docusaurus `start` and `build` [cli command
 "build": "docusaurus build",
 ```
 
-Once built the docs will be available at `/docs/api` or equivalent out directory.
+Once built the docs will be available at `/docs/api` (or equivalent out directory).
+
+### Directory structure
 
 ```
-docs-website
-├── build/ (static site dir)
-├── docs/
-│   ├── api/ (compiled typedoc markdown)
-├── docusaurus.config.js
-├── package.json
-├── sidebars.js
+├── docusauruss-website
+    ├── build/ (static site dir)
+    ├── docs/
+    │   ├── api/ (compiled typedoc markdown)
+    ├── docusaurus.config.js
+    ├── package.json
+    ├── sidebars.js
+├──package.json
+├──src (typescript source files)
+├──tsconfig.json
 ```
 
 
@@ -103,12 +96,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 directory relative to docs directory. |
-| `sidebar.categoryLabel` | `API`   | The sidebar parent category label.           |
-| `sidebar.fullNames`     | `false` | Display full names with module path.         |
-| `sidebar.position`      | `null`  | 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
 
@@ -137,13 +130,16 @@ module.exports = {
 };
 ```
 
-## Sidebar and Navbar
 
-### Sidebar
+## Recipes
+
+### Sidebar and Navbar
+
+#### Sidebar
 
 `sidebars.js` can be configured in following ways:
 
-1 ) Generate the entire sidebar from file structure of your docs folder (default behaviour):
+1) Generate the entire sidebar from file structure of your docs folder (default behaviour):
 
 ```js
 module.exports = {
@@ -156,9 +152,9 @@ module.exports = {
 };
 ```
 
-2 ) Alternatively, if you wish to manually control other parts of your sidebar you can use a slice for the TypeDoc sidebar.
+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` and `sidebar.position` options are ignored with this implementation)
 
 ```js
 module.exports = {
@@ -176,7 +172,7 @@ module.exports = {
 
 Please see https://docusaurus.io/docs/sidebar for sidebar documentation.
 
-### Navbar
+#### Navbar
 
 A navbar item can be configured in `themeConfig` options in `docusaurus.config.js`:
 
@@ -197,7 +193,6 @@ A navbar item can be configured in `themeConfig` options in `docusaurus.config.j
 
 Please see https://docusaurus.io/docs/api/themes/configuration#navbar-items for navbar documentation.
 
-## Additional config
 
 ### Multi instance
 

package/dist/options.js

@@ -18,6 +18,7 @@ const DEFAULT_PLUGIN_OPTIONS = {
     entryDocument: 'index.md',
     plugin: ['none'],
     watch: false,
+    indexSlug: undefined,
 };
 const getPluginOptions = (opts) => {
     const options = {

package/dist/render.js

@@ -61,6 +61,9 @@ const addTypedocDeclarations = (app) => {
     app.options.addDeclaration({
         name: 'readmeTitle',
     });
+    app.options.addDeclaration({
+        name: 'indexSlug',
+    });
     app.options.addDeclaration({
         name: 'sidebar',
         type: typedoc_1.ParameterType.Mixed,

package/dist/theme.d.ts

@@ -4,6 +4,7 @@ import { SidebarOptions } from './types';
 export declare class DocusaurusTheme extends MarkdownTheme {
     sidebar: SidebarOptions;
     readmeTitle: string;
+    indexSlug: string;
     constructor(renderer: Renderer);
     getRelativeUrl(url: string): string;
     onPageEnd(page: PageEvent<DeclarationReflection>): void;
@@ -13,6 +14,7 @@ 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

@@ -83,10 +83,7 @@ class DocusaurusTheme extends theme_1.MarkdownTheme {
             title: pageTitle,
         };
         if (page.url === this.entryDocument) {
-            items = {
-                ...items,
-                slug: `/${path.relative(process.cwd(), this.out).replace(/\\/g, '/')}/`,
-            };
+            items = { ...items, slug: this.getSlug() };
         }
         if (sidebarLabel && sidebarLabel !== pageTitle) {
             items = { ...items, sidebar_label: sidebarLabel };
@@ -137,6 +134,15 @@ 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)) {
@@ -158,6 +164,9 @@ __decorate([
 __decorate([
     (0, typedoc_1.BindOption)('readmeTitle')
 ], DocusaurusTheme.prototype, "readmeTitle", void 0);
+__decorate([
+    (0, typedoc_1.BindOption)('indexSlug')
+], DocusaurusTheme.prototype, "indexSlug", void 0);
 exports.DocusaurusTheme = DocusaurusTheme;
 const writeCategoryYaml = (categoryPath, label, position) => {
     const yaml = [`label: "${label}"`];

package/dist/types.d.ts

@@ -14,6 +14,7 @@ export interface PluginOptions {
     hideBreadcrumbs: boolean;
     hidePageTitle: boolean;
     entryDocument: string;
+    indexSlug?: string;
 }
 export interface FrontMatter {
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "0.16.4",
+  "version": "0.16.5",
   "description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.",
   "main": "dist/index.js",
   "files": [
@@ -42,5 +42,5 @@
     "typescript",
     "api"
   ],
-  "gitHead": "07d11744f1312dda8f1017b5ab54456f3521eb75"
+  "gitHead": "eb289daac347deea984351f04ec7d5f82896d281"
 }