diff --git a/docs/api-site-config.md b/docs/api-site-config.md index 78a50d29a0..e2d458a7ba 100644 --- a/docs/api-site-config.md +++ b/docs/api-site-config.md @@ -251,10 +251,22 @@ Path to your web app manifest (e.g., `manifest.json`). This will add a `` Override default [Remarkable options](https://github.com/jonschlinkert/remarkable#options) that will be used to render markdown. +> To manage [syntax extensions](https://github.com/jonschlinkert/remarkable#syntax-extensions), use the `markdownPlugins` field. + #### `markdownPlugins` [array] An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined. +For example, if you want to [enable superscript and subscript](https://github.com/jonschlinkert/remarkable#syntax-extensions) in your markdown that is rendered by Remarkable to HTML, you would do the following: + +``` + markdownPlugins: [ + function foo(md) { + md.inline.ruler.enable(['sub', 'sup']); + }, + ], +``` + #### `noIndex` [boolean] Boolean. If true, Docusaurus will politely ask crawlers and search engines to avoid indexing your site. This is done with a header tag and so only applies to docs and pages. Will not attempt to hide static resources. This is a best effort request. Malicious crawlers can and will still index your site.