chore: Updated docs

CONTRIBUTING.md

@@ -1,5 +1,7 @@
 # Contributing Guide
 
+> The contributing guide is under development and incomplete.
+
 Thank you showing interest in contributing. Contributions and feedback are very welcome.
 
 Before you start, you might find it helpful to read the TypeDoc's [development guide](https://typedoc.org/guides/development/) to understand the architecture of TypeDoc itself.

README.md

@@ -1,25 +1,26 @@
-# Typedoc Plugin Markdown
+# typedoc-plugin-markdown
 
-Welcome to the Typedoc Plugin Markdown project! This project is a collection of packages designed for outputing TypeDoc as Markdown.
+This project is a collection of packages designed for generate TypeScript API documentation as Markdown.
 
 ## Documentation
 
-Please visit [typedoc-plugin-markdown.org](https://typedoc-plugin-markdown.org) for comprehensive documentation, including options and usage guides.
+Please visit the [undefined](undefined) for comprehensive documentation, including options and usage guides.
 
 ## Packages
 
 | Package | Badges | 
 | :---| :---|
 [typedoc-plugin-markdown](./packages/typedoc-plugin-markdown#readme) | ![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-markdown) | 
-[typedoc-plugin-frontmatter](./packages/typedoc-plugin-frontmatter#readme) | ![npm](https://img.shields.io/npm/v/typedoc-plugin-frontmatter%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-frontmatter) | 
-[typedoc-plugin-remark](./packages/typedoc-plugin-remark#readme) | ![npm](https://img.shields.io/npm/v/typedoc-plugin-remark%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-remark) | 
+[docusaurus-plugin-typedoc](./packages/docusaurus-plugin-typedoc#readme) | ![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/docusaurus-plugin-typedoc) | 
 [typedoc-github-wiki-theme](./packages/typedoc-github-wiki-theme#readme) | ![npm](https://img.shields.io/npm/v/typedoc-github-wiki-theme%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-github-wiki-theme) | 
+[typedoc-plugin-frontmatter](./packages/typedoc-plugin-frontmatter#readme) | ![npm](https://img.shields.io/npm/v/typedoc-plugin-frontmatter%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-frontmatter) | 
 [typedoc-vitepress-theme](./packages/typedoc-vitepress-theme#readme) | ![npm](https://img.shields.io/npm/v/typedoc-vitepress-theme%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-vitepress-theme) | 
-[docusaurus-plugin-typedoc](./packages/docusaurus-plugin-typedoc#readme) | ![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/docusaurus-plugin-typedoc) | 
+[typedoc-gitlab-wiki-theme](./packages/typedoc-gitlab-wiki-theme#readme) | ![npm](https://img.shields.io/npm/v/typedoc-gitlab-wiki-theme%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-gitlab-wiki-theme) | 
+[typedoc-plugin-remark](./packages/typedoc-plugin-remark#readme) | ![npm](https://img.shields.io/npm/v/typedoc-plugin-remark%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-remark) | 
 
 ## Examples
 
-Please see .
+Please see the [examples repository](https://github.com/tgreyuk/typedoc-plugin-markdown-examples).
 
 ## Contributing
 

devtools/scripts/generate-readmes.ts

@@ -27,11 +27,12 @@ async function copyChangelog() {
 async function main() {
   const packagesPromises = [
     'typedoc-plugin-markdown',
-    'typedoc-plugin-frontmatter',
-    'typedoc-plugin-remark',
+    'docusaurus-plugin-typedoc',
     'typedoc-github-wiki-theme',
+    'typedoc-plugin-frontmatter',
     'typedoc-vitepress-theme',
-    'docusaurus-plugin-typedoc',
+    'typedoc-gitlab-wiki-theme',
+    'typedoc-plugin-remark',
   ].map(async (packageName) => {
     const packageJson = await import(
       `../../packages/${packageName}/package.json`
@@ -51,10 +52,10 @@ async function main() {
 }
 
 function writeRepositoryReadme(packages: any) {
-  const readme: string[] = ['# Typedoc Plugin Markdown'];
+  const readme: string[] = ['# typedoc-plugin-markdown'];
 
   readme.push(
-    'Welcome to the Typedoc Plugin Markdown project! This project is a collection of packages designed for outputing TypeDoc as Markdown.',
+    'This project is a collection of packages designed for generate TypeScript API documentation as Markdown.',
   );
 
   readme.push('## Documentation');
@@ -84,7 +85,9 @@ function writeRepositoryReadme(packages: any) {
 
   readme.push('## Examples');
 
-  readme.push('Please see .');
+  readme.push(
+    'Please see the [examples repository](https://github.com/tgreyuk/typedoc-plugin-markdown-examples).',
+  );
 
   readme.push('## Contributing');
 
@@ -100,10 +103,14 @@ function writeRepositoryReadme(packages: any) {
 }
 
 function writePackageReadme(packageItem: any) {
+  const ciName =
+    packageItem.name === 'typedoc-plugin-markdown'
+      ? 'ci.yml'
+      : `ci.${packageItem.name}.yml`;
   const readme = [`# ${packageItem.name}`];
   const badges = [
     `![npm](https://img.shields.io/npm/v/${packageItem.name}%2Fnext?\&logo=npm)`,
-    `[![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=next)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml)`,
+    `[![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/${ciName}/badge.svg?branch=next)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/${ciName})`,
   ];
 
   readme.push(badges.join(' '));
@@ -114,7 +121,7 @@ function writePackageReadme(packageItem: any) {
 
   readme.push('## Installation');
   readme.push(`\`\`\`shell
-  npm install ${packageItem.name} --save-dev
+  npm install ${packageItem.name}@next --save-dev
   \`\`\``);
 
   readme.push('## Documentation');
@@ -128,5 +135,5 @@ function writePackageReadme(packageItem: any) {
 }
 
 function docText(docLink?: string) {
-  return `Please visit [typedoc-plugin-markdown.org](${docLink || 'https://typedoc-plugin-markdown.org'}) for comprehensive documentation, including options and usage guides.`;
+  return `Please visit the [${docLink}](${docLink}) for comprehensive documentation, including options and usage guides.`;
 }

docs/pages/api-docs/index.mdx

@@ -1,6 +1,6 @@
 # API
 
-The public API of the typedoc-plugin-markdown exposes some classes and types that can be used to customize the output of the plugin. Please note this only covers the API relevant to this plugin and not cover the entire [TypeDoc API](https://typedoc.org/api/).
+The public API of typedoc-plugin-markdown exposes some classes and types that can be used to customize the output of the plugin. Please note this only covers the API relevant to this plugin and not cover the entire [TypeDoc API](https://typedoc.org/api/).
 
 The APIs are typically consumed by writing [local plugins](/docs/customizing-output#local-plugins).
 

docs/pages/docs/changelog.mdx

@@ -9,42 +9,44 @@ import { Callout } from 'nextra/components';
 ### 🏗 Architectural Changes
 
 - Handlebars as a dependency has been removed.
-- Updated customization model with the ability to set hooks, events and cutom theming. See [customization guide]().
-- Exposed navigation structure. See [navigation guide]().
+- Updated customization model with the ability to set hooks, events and custom theming.
+- Exposed navigation structure.
+- Greater test coverage including parsing linting output with MarkdownLint and remark-mdx.
 
 ### 🌟 Features
 
 - Updated output file structure.
 - Improved and cleaner UI.
 - A set of updated and additional new options with comprehensive documentation.
+- Exported option types and JSON schema.
 
 ### 🚀 Migrating from v3
 
 Migrating from v3 to v4 should be fairly straightforward. These pointers will help you understand the changes and how to update your project.
 
 #### 🏗️ Structural Changes
 
-- Each member is now output to its own file by default. See [`outputFileStrategy`](/docs/options#outputfilestrategy). To achieve the same output as v3 (whereby only Classes, Enums and Interfaces have their own file), set the [`membersWithOwnFile`](/docs/options#memberswithownfile) option.
-- Parameters are output as a list by default. To achieve the same output as v3 (where parameters are output as a table), use [`parametersFormat`](/docs/options#parametersformat).
+- Each module member is now output to its own file by default. See [`outputFileStrategy`](/docs/options#outputfilestrategy). To achieve the same output as v3 (whereby only Classes, Enums and Interfaces have their own file), set the [`membersWithOwnFile`](/docs/options#memberswithownfile) option.
+- Parameters are output as a list by default. To achieve the same output as v3 (where parameters are output as a table), use [`parametersFormat=table`](/docs/options#parametersformat).
 
 #### 💥 Breaking Changes
 
 - Because the file structure has changed you may need to update any cross references to files in your documentation.
 - Setting `theme` to `"markdown"` is no longer required and should be removed.
 - The option `indexTitle` has been removed. Please use the `"title.indexPage"` key with [`textContentMappings`](/docs/options#textcontentmappings).
-- The option `allReflectionsHaveOwnDocument` has beeen removed (this behaviour is now the default). Please see See [`outputFileStrategy`](/docs/options#outputfilestrategy).
+- The option `allReflectionsHaveOwnDocument` has been removed (this behaviour is now the default). Please see See [`outputFileStrategy`](/docs/options#outputfilestrategy).
 - The option `entryDocument` has been renamed to `entryFileName` to better reflect its purpose.
 - The option `namedAnchors` has been renamed to `useHTMLAnchors` to better reflect its purpose.
 - The option `hideInPageTOC` has been removed. In-page TOC are no longer included by default. You can include in-page TOCs by using [typedoc-plugin-remark](/plugins/remark) and the [remark-toc](plugins/remark/suggested-plugins#remark-toc) plugin.
-- The option `objectLiteralTypeDeclarationStyle` has been removed. Please use [`typeDeclarationFormat`](/docs/options#typedeclarationformat).
+- The option `objectLiteralTypeDeclarationStyle` has been removed. Please use [`typeDeclarationFormat=list`](/docs/options#typedeclarationformat).
 
 ### 🐛 Bug Fixes
 
 The release features numerous bug fixes including:
 
 - Duplication in callback/callable/function properties. ([#581](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/581)).
 - @experimental / @internal annotations. ([#556](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/556))
-- Fix events output and strikethough deprecqted items. ([#534](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/534))
+- Fix events output and strike-through deprecated items. ([#534](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/534))
 - Class static functions are no longer marked. ([#533](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/533))
 - @example block not rendered with Headline ([#501](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/501))
 - Support for categories ([#499](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/499))

docs/pages/docs/using-typedoc.mdx

@@ -44,7 +44,7 @@ module.exports = {
 
 The majority of [TypeDoc's options](https://typedoc.org/options/) are used internally by TypeDoc to convert a project and define the structure of the models.
 
-These options are output/theme agnostic and can be set in the same as you would with the HTML theme:
+These options are output/theme agnostic and can be set in the same way as you would with the HTML theme:
 
 - [Configuration](https://typedoc.org/options/configuration/) Yes ✅
 - [Input](https://typedoc.org/options/input/) Yes ✅

packages/docusaurus-plugin-typedoc/README.md

@@ -1,15 +1,15 @@
 # docusaurus-plugin-typedoc
 
-![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc%2Fnext?&logo=npm) [![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=next)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml)
+![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc%2Fnext?&logo=npm) [![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.docusaurus-plugin-typedoc.yml/badge.svg?branch=next)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.docusaurus-plugin-typedoc.yml)
 
 A Docusaurus plugin to integrate TypeDoc ( + typedoc-plugin-markdown ) into a Docusaurus project.
 
 ## Installation
 
 ```shell
-  npm install docusaurus-plugin-typedoc --save-dev
+  npm install docusaurus-plugin-typedoc@next --save-dev
   ```
 
 ## Documentation
 
-Please visit [typedoc-plugin-markdown.org](https://typedoc-plugin-markdown.org/plugins/docusaurus) for comprehensive documentation, including options and usage guides.
+Please visit the [https://typedoc-plugin-markdown.org/plugins/docusaurus](https://typedoc-plugin-markdown.org/plugins/docusaurus) for comprehensive documentation, including options and usage guides.

packages/typedoc-github-wiki-theme/README.md

@@ -1,15 +1,15 @@
 # typedoc-github-wiki-theme
 
-![npm](https://img.shields.io/npm/v/typedoc-github-wiki-theme%2Fnext?&logo=npm) [![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=next)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml)
+![npm](https://img.shields.io/npm/v/typedoc-github-wiki-theme%2Fnext?&logo=npm) [![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.typedoc-github-wiki-theme.yml/badge.svg?branch=next)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.typedoc-github-wiki-theme.yml)
 
 A TypeDoc ( + typedoc-plugin-markdown ) theme that generates docs compatible with Github Wiki.
 
 ## Installation
 
 ```shell
-  npm install typedoc-github-wiki-theme --save-dev
+  npm install typedoc-github-wiki-theme@next --save-dev
   ```
 
 ## Documentation
 
-Please visit [typedoc-plugin-markdown.org](https://typedoc-plugin-markdown.org/plugins/github-wiki) for comprehensive documentation, including options and usage guides.
+Please visit the [https://typedoc-plugin-markdown.org/plugins/github-wiki](https://typedoc-plugin-markdown.org/plugins/github-wiki) for comprehensive documentation, including options and usage guides.

packages/typedoc-gitlab-wiki-theme/README.md

@@ -1,23 +1,15 @@
 # typedoc-gitlab-wiki-theme
 
-![npm](https://img.shields.io/npm/v/typedoc-gitlab-wiki-theme%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-gitlab-wiki-theme) [![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=next)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml)
+![npm](https://img.shields.io/npm/v/typedoc-gitlab-wiki-theme%2Fnext?&logo=npm) [![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.typedoc-gitlab-wiki-theme.yml/badge.svg?branch=next)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.typedoc-gitlab-wiki-theme.yml)
 
 A TypeDoc ( + typedoc-plugin-markdown ) theme that generates docs compatible with Gitlab Wiki.
 
 ## Installation
 
 ```shell
-  npm install typedoc-gitlab-wiki-theme --save-dev
+  npm install typedoc-gitlab-wiki-theme@next --save-dev
   ```
 
 ## Documentation
 
-Please visit https://typedoc-plugin-markdown.org/themes/gitlab-wiki.
-
-## Contributing
-
-If you would like to contribute please read the [contributing guide](./CONTRIBUTING.md).
-
-## License
-
-Released under the [MIT License](./LICENSE).
+Please visit the [https://typedoc-plugin-markdown.org/plugins/gitlab-wiki](https://typedoc-plugin-markdown.org/plugins/gitlab-wiki) for comprehensive documentation, including options and usage guides.

packages/typedoc-plugin-frontmatter/README.md

@@ -1,15 +1,15 @@
 # typedoc-plugin-frontmatter
 
-![npm](https://img.shields.io/npm/v/typedoc-plugin-frontmatter%2Fnext?&logo=npm) [![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=next)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml)
+![npm](https://img.shields.io/npm/v/typedoc-plugin-frontmatter%2Fnext?&logo=npm) [![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.typedoc-plugin-frontmatter.yml/badge.svg?branch=next)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.typedoc-plugin-frontmatter.yml)
 
 A plugin for TypeDoc that prepends configurable frontmatter to page content.
 
 ## Installation
 
 ```shell
-  npm install typedoc-plugin-frontmatter --save-dev
+  npm install typedoc-plugin-frontmatter@next --save-dev
   ```
 
 ## Documentation
 
-Please visit [typedoc-plugin-markdown.org](https://typedoc-plugin-markdown.org/plugins/frontmatter) for comprehensive documentation, including options and usage guides.
+Please visit the [https://typedoc-plugin-markdown.org/plugins/frontmatter](https://typedoc-plugin-markdown.org/plugins/frontmatter) for comprehensive documentation, including options and usage guides.

packages/typedoc-plugin-frontmatter/package.json

@@ -35,7 +35,6 @@
   },
   "keywords": [
     "frontmatter",
-    "typedoc",
-    "typedoc-plugin"
+    "typedoc"
   ]
 }