Skip to content

Commit

Permalink
docs: Fix Rendering of <AUTOGENERATED_TABLE_OF_CONTENTS> Tag on API -…
Browse files Browse the repository at this point in the history
… Markdown Features Page (#1617)
  • Loading branch information
dhurlburtusa authored and endiliey committed Jul 12, 2019
1 parent 7b7d1e6 commit 684a246
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/api-doc-markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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:

Expand Down Expand Up @@ -144,10 +144,12 @@ Adding the following code to your Markdown file:
produces this:

<!--DOCUSAURUS_CODE_TABS-->

<!--JavaScript-->
```js
console.log('Hello, world!');
```

<!--Python-->
```py
print('Hello, world!')
Expand Down

0 comments on commit 684a246

Please sign in to comment.