Useful Plugins

Here are a selection of remark plugins that might be useful. For a full list please visit the remark plugins page

remark-mdx


npm install remark-mdx --save-dev


pnpm add remark-mdx --save-dev


yarn add remark-mdx --dev


bun add remark-mdx --dev

typedoc.json


{
  "remarkPlugins": ["remark-mdx"]
}

Links references to commits, issues, and users in the same way that GitHub does in comments.


npm install remark-github --save-dev


pnpm add remark-github --save-dev


yarn add remark-github --dev


bun add remark-github --dev

typedoc.json


{
  "remarkPlugins": ["remark-github", { "repository": "myorg/myrepo" }]
}

Note: Also requires remark-insert-headings to add insert placeholder heading.


npm install remark-insert-headings remark-toc --save-dev


pnpm add remark-insert-headings remark-toc --save-dev


yarn add remark-insert-headings remark-toc --dev


bun add remark-insert-headings remark-toc --dev

typedoc.json


{
  "remarkPlugins": [
    ["remark-insert-headings", { "text": "Contents" }],
    ["remark-toc", { "maxDepth": 2 }]
  ]
}