tauri-apps/archived-typedoc-plugin-markdown
1
0
Fork 0
mirror of https://github.com/tauri-apps/typedoc-plugin-markdown.git synced 2026-01-31 00:45:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Readme updates

Browse Source
This commit is contained in:
tgreyuk
2021-05-11 00:06:44 +01:00
parent 616ca4e0e2
commit a26bec0636
2 changed files with 13 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -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. |

23
packages/typedoc-plugin-markdown/README.md
View File

@@ -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