@dfinity/typedoc-plugin-icp-docs

This is a plugin for Typedoc that prepares Markdown documentation to be published to js.icp.build.

Installation

npm install --save-dev @dfinity/typedoc-plugin-icp-docs

This plugin requires the typedoc-plugin-markdown and typedoc-plugin-frontmatter plugins, so you need to install them as well.

Usage

In your typedoc.json file, add the plugin and the output:

{
  "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 and typedoc-plugin-frontmatter plugins, so you need to configure them as well.

For a more concrete setup example, see the docs folder of the dfinity/pic-js repository.

Development

See HACKING.md for more information.

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for more information.

License

This project is licensed under the Apache License 2.0. See LICENSE for more information.