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.`;
 }

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"
   ]
 }

packages/typedoc-plugin-markdown/README.md

@@ -7,9 +7,9 @@ A plugin for TypeDoc that enables TypeScript API documentation to be generated i
 ## Installation
 
 ```shell
-  npm install typedoc-plugin-markdown --save-dev
+  npm install typedoc-plugin-markdown@next --save-dev
   ```
 
 ## Documentation
 
-Please visit [typedoc-plugin-markdown.org](https://typedoc-plugin-markdown.org/docs) for comprehensive documentation, including options and usage guides.
+Please visit the [https://typedoc-plugin-markdown.org/docs](https://typedoc-plugin-markdown.org/docs) for comprehensive documentation, including options and usage guides.

packages/typedoc-plugin-remark/README.md

@@ -1,15 +1,15 @@
 # typedoc-plugin-remark
 
-![npm](https://img.shields.io/npm/v/typedoc-plugin-remark%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-remark%2Fnext?&logo=npm) [![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.typedoc-plugin-remark.yml/badge.svg?branch=next)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.typedoc-plugin-remark.yml)
 
 A plugin for TypeDoc that enables additional markdown transformations with remark plugins.
 
 ## Installation
 
 ```shell
-  npm install typedoc-plugin-remark --save-dev
+  npm install typedoc-plugin-remark@next --save-dev
   ```
 
 ## Documentation
 
-Please visit [typedoc-plugin-markdown.org](https://typedoc-plugin-markdown.org/plugins/remark) for comprehensive documentation, including options and usage guides.
+Please visit the [https://typedoc-plugin-markdown.org/plugins/remark](https://typedoc-plugin-markdown.org/plugins/remark) for comprehensive documentation, including options and usage guides.

packages/typedoc-vitepress-theme/README.md

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