default includeExtension to true

typedoc2md · Feb 18, 2022 · bd1a3cd · bd1a3cd
1 parent 3e4eede
commit bd1a3cd
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/packages/docusaurus-plugin-typedoc/README.md b/packages/docusaurus-plugin-typedoc/README.md
@@ -98,7 +98,7 @@ 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`      | `false` | 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) |
+| `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) |
 | `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.                                                                                                                                                                     |

diff --git a/packages/docusaurus-plugin-typedoc/src/options.ts b/packages/docusaurus-plugin-typedoc/src/options.ts
@@ -17,7 +17,7 @@ const DEFAULT_PLUGIN_OPTIONS: PluginOptions = {
   entryDocument: 'index.md',
   plugin: ['none'],
   watch: false,
-  includeExtension: false,
+  includeExtension: true,
   indexSlug: undefined,
   theme: 'docusaurus',
 };

diff --git a/packages/docusaurus-plugin-typedoc/src/theme.ts b/packages/docusaurus-plugin-typedoc/src/theme.ts
@@ -41,7 +41,7 @@ export class DocusaurusTheme extends MarkdownTheme {
   indexSlug!: string;
 
   @BindOption('includeExtension')
-  includeExtension!: boolean;
+  includeExtension!: string;
 
   constructor(renderer: Renderer) {
     super(renderer);
@@ -53,7 +53,7 @@ export class DocusaurusTheme extends MarkdownTheme {
   }
 
   getRelativeUrl(url: string) {
-    const re = new RegExp(this.includeExtension ? '' : '.md', 'g');
+    const re = new RegExp(this.includeExtension === 'true' ? '' : '.md', 'g');
     const relativeUrl = super.getRelativeUrl(url).replace(re, '');
     if (path.basename(relativeUrl).startsWith('index')) {
       // always remove the extension for the index or else it creates weird paths like `../.md`