docs: Fix Rendering of <AUTOGENERATED_TABLE_OF_CONTENTS> Tag on API - Markdown Features Page (#1617)

This commit is contained in:
Danny Hurlburt 2019-07-12 09:32:52 -06:00 committed by Endi
parent 7b7d1e6161
commit 684a2461bd

View file

@ -109,7 +109,7 @@ Example:
You can make an auto-generated list of links, which can be useful as a table of contents for API docs. You can make an auto-generated list of links, which can be useful as a table of contents for API docs.
In your markdown file, insert a line with the text `<AUTOGENERATED_TABLE_OF_CONTENTS>`. Write your documentation using `h3` headers for each function inside a code block. These will be found by Docusaurus and a list of links to these sections will be inserted at the text `<AUTOGENERATED_TABLE_OF_CONTENTS>`. In your markdown file, insert a line with the text <code>&lt;AUTOGENERATED_TABLE_OF_CONTENTS></code>. Write your documentation using `h3` headers for each function inside a code block. These will be found by Docusaurus and a list of links to these sections will be inserted at the text `<AUTOGENERATED_TABLE_OF_CONTENTS>`.
Example: Example:
@ -144,10 +144,12 @@ Adding the following code to your Markdown file:
produces this: produces this:
<!--DOCUSAURUS_CODE_TABS--> <!--DOCUSAURUS_CODE_TABS-->
<!--JavaScript--> <!--JavaScript-->
```js ```js
console.log('Hello, world!'); console.log('Hello, world!');
``` ```
<!--Python--> <!--Python-->
```py ```py
print('Hello, world!') print('Hello, world!')