diff --git a/README.md b/README.md index 5ab3d19..559064b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@ | Package | Version | Description | | :---------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------- | | [typedoc-plugin-markdown](./packages/typedoc-plugin-markdown) | [![typedoc-plugin-markdown](https://img.shields.io/npm/v/typedoc-plugin-markdown.svg)](https://www.npmjs.com/package/typedoc-plugin-markdown) | A plugin for TypeDoc that renders documentation as Markdown. | +| [docusaurus-plugin-typedoc](./packages/docusaurus-plugin-typedoc) | [![docusaurus-plugin-typedoc](https://img.shields.io/npm/v/docusaurus-plugin-typedoc.svg)](https://www.npmjs.com/package/docusaurus-plugin-typedoc) | A Docusaurus v2 plugin to build documentation with TypeDoc. | +| [vuepress-plugin-typedoc](./packages/vuepress-plugin-typedoc) | [![vuepress-plugin-typedoc](https://img.shields.io/npm/v/vuepress-plugin-typedoc.svg)](https://www.npmjs.com/package/vuepress-plugin-typedoc) | A VuePress plugin to build documentation with TypeDoc. | | [typedoc-github-wiki-theme](./packages/typedoc-github-wiki-theme) | [![typedoc-github-wiki-theme](https://img.shields.io/npm/v/typedoc-github-wiki-theme.svg)](https://www.npmjs.com/package/typedoc-github-wiki-theme) | A Github Wiki compatible TypeDoc theme. | | [typedoc-gitlab-wiki-theme](./packages/typedoc-gitlab-wiki-theme) | [![typedoc-gitlab-wiki-theme](https://img.shields.io/npm/v/typedoc-gitlab-wiki-theme.svg)](https://www.npmjs.com/package/typedoc-gitlab-wiki-theme) | A Gitlab Wiki compatible TypeDoc theme. | -| [typedoc-hugo-theme](./packages/typedoc-hugo-theme) | [![typedoc-hugo-theme](https://img.shields.io/npm/v/typedoc-hugo-theme.svg)](https://www.npmjs.com/package/typedoc-hugo-theme) | A Hugo compatible TypeDoc theme. | -| [docusaurus-plugin-typedoc](./packages/docusaurus-plugin-typedoc) | [![docusaurus-plugin-typedoc](https://img.shields.io/npm/v/docusaurus-plugin-typedoc.svg)](https://www.npmjs.com/package/docusaurus-plugin-typedoc) | A Docusaurus v2 plugin to build documentation with TypeDoc. | -| [vuepress-plugin-typedoc](./packages/vuepress-plugin-typedoc) | [![vuepress-plugin-typedoc](https://img.shields.io/npm/v/vuepress-plugin-typedoc.svg)](https://www.npmjs.com/package/vuepress-plugin-typedoc) | A VuePress plugin to build documentation with TypeDoc. | \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/README.md b/packages/typedoc-plugin-markdown/README.md index 2aa0eeb..3fbda89 100644 --- a/packages/typedoc-plugin-markdown/README.md +++ b/packages/typedoc-plugin-markdown/README.md @@ -42,24 +42,23 @@ The following options can be used in addition to relevant [TypeDoc options](http Use HTML named anchors tags for implementations that do not assign header ids. Defaults to `false`. -## Additional themes and plugins +## Additional plugins and thene -If targeting specific static site generators or wiki platforms the following themes and plugins may be of interest: - -### Themes - -Themes that target particular Markdown platforms: - -- Github Wiki: [typedoc-github-wiki-theme](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/packages/typedoc-github-wiki-theme/README.md) -- GitLab Wiki: [typedoc-gitlab-wiki-theme](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/packages/typedoc-gitlab-wiki-theme/README.md) -- Hugo: [typedoc-hugo-theme](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/packages/typedoc-hugo-theme/README.md) +If targeting specific static site generators or wiki platforms the following plugins and themes may be of interest: ### Plugins Plugins that integrates TypeDoc seamlessly with a particular platform ecosystem: -- Docusaurus v2: [docusaurus-plugin-typedoc](https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc/README.md) -- VuePress: [vuepress-plugin-typedoc](https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/vuepress-plugin-typedoc/README.md) +- Docusaurus v2 - [docusaurus-plugin-typedoc](https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc/README.md) +- VuePress - [vuepress-plugin-typedoc](https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/vuepress-plugin-typedoc/README.md) + +### Themes + +Themes that target output to particular Markdown platforms: + +- GitHub Wiki - [typedoc-github-wiki-theme](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/packages/typedoc-github-wiki-theme/README.md) +- GitLab Wiki - [typedoc-gitlab-wiki-theme](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/packages/typedoc-gitlab-wiki-theme/README.md) ## License