From 684a2461bdbb27f94f30b891a6e1683b23c79489 Mon Sep 17 00:00:00 2001 From: Danny Hurlburt Date: Fri, 12 Jul 2019 09:32:52 -0600 Subject: [PATCH] docs: Fix Rendering of Tag on API - Markdown Features Page (#1617) --- docs/api-doc-markdown.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/api-doc-markdown.md b/docs/api-doc-markdown.md index 19c7112cb07a..7003a7023522 100644 --- a/docs/api-doc-markdown.md +++ b/docs/api-doc-markdown.md @@ -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 ``. 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 ``. +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 ``. Example: @@ -144,10 +144,12 @@ Adding the following code to your Markdown file: produces this: + ```js console.log('Hello, world!'); ``` + ```py print('Hello, world!')