3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-31 18:07:00 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: add more clarity about markdown fields (#1589)

Browse source 
I wanted to enable superscript and subscripting to a v1 site. It wasn't quite clear how to do it. @yangshun helped me figure it out. So I thought I would document it.
This commit is contained in:
Joel Marcey 2019-06-07 12:55:24 -07:00 • committed by Yangshun Tay
parent 111a21ea08
commit b2fe2a65c8
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/api-site-config.md
View file

@ -251,10 +251,22 @@ Path to your web app manifest (e.g., `manifest.json`). This will add a `<link>`
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.