https://github.com/dfinity/typedoc-plugin-icp-docs
Typedoc plugin to assemble docs for js.icp.build
https://github.com/dfinity/typedoc-plugin-icp-docs
br-protected-1 icp markdown typedoc typedoc-plugin typescript
Last synced: 5 months ago
JSON representation
Typedoc plugin to assemble docs for js.icp.build
- Host: GitHub
- URL: https://github.com/dfinity/typedoc-plugin-icp-docs
- Owner: dfinity
- License: apache-2.0
- Created: 2025-09-18T21:27:55.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-10-24T08:18:09.000Z (8 months ago)
- Last Synced: 2025-10-24T09:17:08.470Z (8 months ago)
- Topics: br-protected-1, icp, markdown, typedoc, typedoc-plugin, typescript
- Language: TypeScript
- Homepage:
- Size: 40 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# @dfinity/typedoc-plugin-icp-docs
[](https://www.npmjs.com/package/@dfinity/typedoc-plugin-icp-docs)
This is a plugin for [Typedoc](https://typedoc.org/) that prepares Markdown documentation to be published to [js.icp.build](https://js.icp.build).
## Installation
```shell
npm install --save-dev @dfinity/typedoc-plugin-icp-docs
```
> This plugin requires the [typedoc-plugin-markdown](https://typedoc-plugin-markdown.org/) and [typedoc-plugin-frontmatter](https://typedoc-plugin-markdown.org/plugins/frontmatter) plugins, so you need to install them as well.
## Usage
In your `typedoc.json` file, add the plugin and the output:
```json
{
"out": "src/content/tmp",
"plugins": [
"typedoc-plugin-markdown",
"typedoc-plugin-frontmatter",
"@dfinity/typedoc-plugin-icp-docs"
],
"outputs": [
{ "name": "markdown", "path": "src/content/tmp" },
{ "name": "icp-docs", "path": "src/content/docs" }
]
}
```
> This plugin requires the [typedoc-plugin-markdown](https://typedoc-plugin-markdown.org/) and [typedoc-plugin-frontmatter](https://typedoc-plugin-markdown.org/plugins/frontmatter) plugins, so you need to configure them as well.
For a more concrete setup example, see the [docs](https://github.com/dfinity/pic-js/tree/main/docs/) folder of the [dfinity/pic-js](https://github.com/dfinity/pic-js) repository.
## Development
See [HACKING.md](./HACKING.md) for more information.
## Contributing
Contributions are welcome! Please see [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for more information.
## License
This project is licensed under the Apache License 2.0. See [LICENSE](./LICENSE) for more information.