© 2020-2022 webdoc Labs

@webdoc/plugin-markdown

This plugin will replace markdown syntax in your document descriptions with HTML markup. You don't need to explicity install this plugin because @webdoc/cli has a dependency on it.

• It uses the markdown-it parser.
• It also adds code highlighting via markdown-it-highlightjs. However, your template must add a hightlight.js stylesheet for it to work.

Usage

In your webdoc.conf.json file, add plugins/markdown to your plugins entry:

{
  plugins: ["plugins/markdown"]
}