Skip to content

Commit

Permalink
adding docs for the automatic table of contents
Browse files Browse the repository at this point in the history
  • Loading branch information
tlienart committed Jul 10, 2019
1 parent b6ac598 commit 7010217
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/src/man/syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Most of what is presented here is also shown in that example.
* [Basic syntax](#Basics-1)
* [Maths](#Maths-1)
* [Div blocks](#Div-blocks-1)
* [Table of contents](#Table-of-contents-1)
* [Using raw HTML](#Using-raw-HTML-1)
* [Comments](#Comments-1)
* [LaTeX commands](#LaTeX-commands-1)
Expand Down Expand Up @@ -126,6 +127,11 @@ which will look like

These div blocks can be nested as in standard HTML.

### Table of contents

JuDoc can insert automatically generated table of contents simply by using `\toc` or `\tableofcontents` somewhere appropriate in your markdown.
The table of contents will be generated in a `jd-toc` div block, so if you would like to modify the styling, you should modify `.jd-toc ol`, `.jd-toc li` etc in your CSS.

### Using raw HTML

You can inject HTML by using `~~~ ... ~~~` which can be useful if, for instance, you occasionally want to use a specific layout such as text next to an image:
Expand Down

0 comments on commit 7010217

Please sign in to comment.