chore(docs): updated readmes

typedoc2md · Jun 22, 2024 · fa8ecff · fa8ecff
1 parent 43c10ac
commit fa8ecff
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 15 deletions.
diff --git a/devguide/README.md b/devguide/README.md
@@ -57,12 +57,12 @@ If the project builds and the tests run successfully you are ready to start cont
 
 ## Packages
 
-| Name                                                               | Version | Description                                                                                                              |
-| ------------------------------------------------------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------ |
-| [typedoc-plugin-markdown](typedoc-plugin-markdown/README.md)       | 4.0.3   | A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.                              |
-| [typedoc-plugin-frontmatter](typedoc-plugin-frontmatter/README.md) | 1.0.0   | A plugin for TypeDoc ( + typedoc-plugin-markdown ) that prepends configurable frontmatter to page content.               |
-| [typedoc-plugin-remark](typedoc-plugin-remark/README.md)           | 1.0.1   | A plugin for TypeDoc ( + typedoc-plugin-markdown ) that enables additional markdown transformations with remark plugins. |
-| [typedoc-github-wiki-theme](typedoc-github-wiki-theme/README.md)   | 2.0.0   | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with Github Wiki.                       |
-| [typedoc-gitlab-wiki-theme](typedoc-gitlab-wiki-theme/README.md)   | 2.0.1   | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with Gitlab Wiki.                       |
-| [typedoc-vitepress-theme](typedoc-vitepress-theme/README.md)       | 1.0.0   | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with VitePress.                         |
-| [docusaurus-plugin-typedoc](docusaurus-plugin-typedoc/README.md)   | 1.0.1   | A Docusaurus plugin to integrate TypeDoc ( + typedoc-plugin-markdown ) into a Docusaurus project.                        |
+| Name                                                               | Description                                                                                                              |
+| ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
+| [typedoc-plugin-markdown](typedoc-plugin-markdown/README.md)       | A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.                              |
+| [typedoc-plugin-frontmatter](typedoc-plugin-frontmatter/README.md) | A plugin for TypeDoc ( + typedoc-plugin-markdown ) that prepends configurable frontmatter to page content.               |
+| [typedoc-plugin-remark](typedoc-plugin-remark/README.md)           | A plugin for TypeDoc ( + typedoc-plugin-markdown ) that enables additional markdown transformations with remark plugins. |
+| [typedoc-github-wiki-theme](typedoc-github-wiki-theme/README.md)   | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with Github Wiki.                       |
+| [typedoc-gitlab-wiki-theme](typedoc-gitlab-wiki-theme/README.md)   | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with Gitlab Wiki.                       |
+| [typedoc-vitepress-theme](typedoc-vitepress-theme/README.md)       | A TypeDoc ( + typedoc-plugin-markdown ) theme that generates Markdown compatible with VitePress.                         |
+| [docusaurus-plugin-typedoc](docusaurus-plugin-typedoc/README.md)   | A Docusaurus plugin to integrate TypeDoc ( + typedoc-plugin-markdown ) into a Docusaurus project.                        |
diff --git a/devguide/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md b/devguide/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md
@@ -119,6 +119,21 @@ description: A description that will be added to frontmatter.
 ---
 ```
 
+In addition any non standard tags should be added to a `tsdoc.json` file and added next to your `tsconfig.json` file.
+
+```json filename="tsdoc.json"
+{
+  "$schema": "https://developer.microsoft.com/en-us/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "extends": ["typedoc/tsdoc.json"],
+  "tagDefinitions": [
+      {
+          "tagName": "@author",
+          "syntaxKind": "modifier"
+      }
+  ]
+}
+```
+
 ### Example
 
 ```ts
@@ -136,7 +151,7 @@ description: A description that will be added to frontmatter.
 
 ### Defined in
 
-[options/declarations.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L61)
+[options/declarations.ts:76](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L76)
 
 ***
 
@@ -156,7 +171,7 @@ description: A description that will be added to frontmatter.
 
 ### Defined in
 
-[options/declarations.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L66)
+[options/declarations.ts:81](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L81)
 
 ***
 
@@ -181,4 +196,4 @@ This option can configure the output style of frontmatter variables when written
 
 ### Defined in
 
-[options/declarations.ts:77](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L77)
+[options/declarations.ts:92](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L92)
diff --git a/docs/pages/plugins/frontmatter/options.mdx b/docs/pages/plugins/frontmatter/options.mdx
@@ -85,6 +85,21 @@ description: A description that will be added to frontmatter.
 ---
 ```
 
+In addition any non standard tags should be added to a `tsdoc.json` file and added next to your `tsconfig.json` file.
+
+```json filename="tsdoc.json"
+{
+  "$schema": "https://developer.microsoft.com/en-us/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "extends": ["typedoc/tsdoc.json"],
+  "tagDefinitions": [
+    {
+      "tagName": "@author",
+      "syntaxKind": "modifier"
+    }
+  ]
+}
+```
+
 ```json filename="typedoc.json"
 {
   "frontmatterCommentTags": ["author", "description"]

diff --git a/packages/typedoc-plugin-frontmatter/src/options/declarations.ts b/packages/typedoc-plugin-frontmatter/src/options/declarations.ts
@@ -56,6 +56,21 @@ export const indexFrontmatter: Partial<DeclarationOption> = {
  * ---
  * ```
  *
+ * In addition any non standard tags should be added to a `tsdoc.json` file and added next to your `tsconfig.json` file.
+ *
+ * ```json filename="tsdoc.json"
+ * {
+ *   "$schema": "https://developer.microsoft.com/en-us/json-schemas/tsdoc/v0/tsdoc.schema.json",
+ *   "extends": ["typedoc/tsdoc.json"],
+ *   "tagDefinitions": [
+ *       {
+ *           "tagName": "@author",
+ *           "syntaxKind": "modifier"
+ *       }
+ *   ]
+ * }
+ * ```
+ *
  * @example ["author", "description"]
  */
 export const frontmatterCommentTags: Partial<DeclarationOption> = {

diff --git a/packages/typedoc-plugin-markdown/CHANGELOG.md b/packages/typedoc-plugin-markdown/CHANGELOG.md
@@ -1,8 +1,8 @@
 # Changelog
 
-## 4.1.0
+## 4.1.0 (2024-06-22)
 
-### Minor Changes
+### Features
 
 - Theme support for TypeDoc’s 0.26 localization model.
 - Theme support for TypeDoc’s 0.26 documents implementation.

diff --git a/typedoc.json b/typedoc.json
@@ -24,7 +24,7 @@
   "excludePrivate": false,
   "readme": "./packages/README.md",
   "packageOptions": {
-    "includeVersion": true,
+    "includeVersion": false,
     "excludePrivate": false,
     "readme": "./OVERVIEW.md",
     "sortEntryPoints": false,