Merge branch 'dev'

typedoc2md · Jul 10, 2024 · 063ca57 · 063ca57
2 parents b5f30e6 + 78f36ed
commit 063ca57
Show file tree

Hide file tree

Showing 22 changed files with 1,442 additions and 385 deletions.
diff --git a/.changeset/honest-eels-happen.md b/.changeset/honest-eels-happen.md
@@ -0,0 +1,5 @@
+---
+'typedoc-plugin-markdown': minor
+---
+
+- Exposed "modulesFileName" option (#647)
diff --git a/.changeset/nice-rabbits-yell.md b/.changeset/nice-rabbits-yell.md
@@ -0,0 +1,5 @@
+---
+'typedoc-plugin-markdown': minor
+---
+
+- Write `.nojekyll` file if TypeDocs "githubPages" option is true (#650)
diff --git a/devguide/typedoc-plugin-markdown/options/namespaces/declarations/README.md b/devguide/typedoc-plugin-markdown/options/namespaces/declarations/README.md
@@ -573,7 +573,7 @@ This option renders index items either as a simple unordered list or in a table.
 
 When table style is selected the following will be the behaviour:
 
-* For a **members index**, a description column will be added to the table with the first paragraph of the comment summary.
+* For a **members index**, a description column will be added with key `table` - the first paragraph of the comment summary, or key `htmlTable` - the entire comment contents.
 * For a **packages index**, (when `--entryPointStrategy` equals `packages`), the package.json description will be displayed with an additional "Version" column (when `--includeVersion` equals true).
 * For a **documents index** a description column will be added to the table printing the `"description"` frontmatter variable.
 

diff --git a/devtools/packages/prebuild-options/tasks/generate-docs.ts b/devtools/packages/prebuild-options/tasks/generate-docs.ts
@@ -67,6 +67,7 @@ ${presetsJson}
                   tag.getTagName() !== 'deprecated' &&
                   tag.getTagName() !== 'category' &&
                   tag.getTagName() !== 'omitExample' &&
+                  tag.getTagName() !== 'defaultValue' &&
                   tag.getTagName() !== 'example',
               )
               .map((tag) => ({
@@ -87,6 +88,10 @@ ${presetsJson}
               .getTags()
               .find((tag) => tag.getTagName() === 'deprecated')
               ?.getComment(),
+            default: doc
+              .getTags()
+              .find((tag) => tag.getTagName() === 'defaultValue')
+              ?.getComment(),
             category:
               doc
                 .getTags()
@@ -298,21 +303,30 @@ function getType(option: any) {
 }
 
 function getDefaultValue(option) {
+  if (Boolean(option.default)) {
+    return option.default;
+  }
+
   if (option.type === ParameterType.Boolean) {
     return option.defaultValue;
   }
+
   if (option.type === ParameterType.Flags) {
     return JSON.stringify(option.defaults);
   }
+
   if (option.type === ParameterType.Array) {
     return '';
   }
+
   if (option.type === ParameterType.Mixed) {
     return JSON.stringify(option.defaultValue);
   }
+
   if (option.type === ParameterType.Object) {
     return JSON.stringify(option.defaultValue);
   }
+
   return `"${option.defaultValue}"`;
 }
 

diff --git a/docs/pages/docs/options.mdx b/docs/pages/docs/options.mdx
@@ -16,6 +16,7 @@ Options that are used to configure how files are output.
 - [--flattenOutputFiles](./options/file-options.mdx#--flattenoutputfiles)
 - [--fileExtension](./options/file-options.mdx#--fileextension)
 - [--entryFileName](./options/file-options.mdx#--entryfilename)
+- [--modulesFileName](./options/file-options.mdx#--modulesfilename)
 - [--entryModule](./options/file-options.mdx#--entrymodule)
 - [--excludeScopesInPaths](./options/file-options.mdx#--excludescopesinpaths)
 - [--mergeReadme](./options/file-options.mdx#--mergereadme)

diff --git a/docs/pages/docs/options/display-options.mdx b/docs/pages/docs/options/display-options.mdx
@@ -142,7 +142,7 @@ This option renders index items either as a simple unordered list or in a table.
 
 When table style is selected the following will be the behaviour:
 
-- For a **members index**, a description column will be added to the table with the first paragraph of the comment summary.
+- For a **members index**, a description column will be added with key `table` - the first paragraph of the comment summary, or key `htmlTable` - the entire comment contents.
 - For a **packages index**, (when `--entryPointStrategy` equals `packages`), the package.json description will be displayed with an additional "Version" column (when `--includeVersion` equals true).
 - For a **documents index** a description column will be added to the table printing the `"description"` frontmatter variable.
 

diff --git a/docs/pages/docs/options/file-options.mdx b/docs/pages/docs/options/file-options.mdx
@@ -156,6 +156,22 @@ The content of root documentation file will be resolved in the following order:
 }
 ```
 
+## --modulesFileName
+
+<Callout emoji="💡">
+  The file name of the separate modules / index page.
+</Callout>
+
+> Accepts a string value. Defaults to `"modules | packages | globals"`.
+
+Please note this option is not applicable when `--readme` is set to "none" or `--mergeReadme` is set to "true".
+
+```json filename="typedoc.json"
+{
+  "modulesFileName": "documentation"
+}
+```
+
 ## --entryModule
 
 <Callout emoji="💡">

diff --git a/docs/pages/docs/typedoc-usage.mdx b/docs/pages/docs/typedoc-usage.mdx
@@ -29,6 +29,9 @@ Below is a list of which TypeDoc Output options are supported or not:
 - `--theme` Yes ✅ (theme should be MarkdownTheme instance)
 - `--cleanOutputDir` Yes ✅
 - `--basePath` Yes ✅
+- `--lang` Yes ✅
+- `--locale` Yes ✅
+- `--githubPages` Yes ✅ (defaults to `false`)
 - `--hideParameterTypesInTitle` No ❌ (use <OptionLink type="display" name="expandParameters" />)
 - `--navigation` No ❌ (use <OptionLink type="utility" name="navigationModel" />)
 - `--titleLink` No ❌
@@ -42,7 +45,6 @@ Below is a list of which TypeDoc Output options are supported or not:
 - `--cname` No ❌
 - `--sourceLinkExternal` No ❌
 - `--htmlLang` No ❌
-- `--githubPages` No ❌
 - `--cacheBust` No ❌
 - `--gaID` No ❌
 - `--hideGenerator` No ❌

diff --git a/docs/pages/docs/versioning.mdx b/docs/pages/docs/versioning.mdx
@@ -6,20 +6,15 @@ This page should help you understand the versioning rules of the plugin and its
 
 Please note that TypeDoc is still released within the 0.x.x range and may include breaking changes within each minor version release.
 
-For this reason we follow a slightly amended version of semver:
-
-- **Patch** versions will include all bug fixes but might also include non-breaking new features.
-- **Minor** versions will be released in sync with TypeDoc minor versions and will include any necessary API and feature changes to support the new TypeDoc version.
-  All changes will attempt to be made in a backwards compatible manor.
-- **Major** versions will be made if significant and breaking changes to the plugin are made.
+New versions of TypeDoc will be released with a new minor version of the plugin.
 
 ## Node Version
 
 We will follow the Node.js version specified in the TypeDoc `package.json` file.
 
 ## Compatibility Table
 
-| typedoc-plugin-markdown | TypeDoc | Node Version | Release Date |
-| ----------------------- | ------- | ------------ | ------------ |
-| 4.1.x                   | 0.26.x  | >= 18        | 2024-06-22   |
-| 4.0.x                   | 0.25.x  | >= 16        | 2024-05-03   |
+| typedoc-plugin-markdown | TypeDoc | Node Version |
+| ----------------------- | ------- | ------------ |
+| 4.1.x - 4.2.x           | 0.26.x  | >= 18        |
+| 4.0.x                   | 0.25.x  | >= 16        |