(Click here to go back to github repository)
Table of contents will be automatically generated by scanning the document for headings.
If you want some headings to be excluded from TOC, you just do:
The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog.
Following heading will be excluded:
This is a warning class: .warn/.warning
This is an info class: .info
This is an example class: .example
No head
head=false
You can insert links into the table by using <ALT: HREF>
.
Numbers are rounded to 3 decimals if length > 10.
```table
caption: Data table
download: true
csvargs:
delimiter: ","
---
ID,Name,Sex,Age
1,Bob,M,49
2,Alice,F,20
```
Something needs ref [1]
Another statement needs ref [2]
If links are relative path to local files, they should be relative to the markdown file.
Images are lazy-loaded.
<!-- no empty lines among the images -->
![Snapshot](./snapshot.png)
![Snapshot](./snapshot.png)
![Snapshot](./snapshot.png)
Relative image path should be relative to the markdown file.
When pyppl_report
work as a PyPPL
plugin, we usually pass the absolute path. However, when it works as a CLI tool, relative path may be used.
A set of panels are blocks that only occupy one panel space in the page by using tabs or accordions, based on the number of this set of panels.
When number of panels <= 4
we will use tabs, otherwise accordions are used.
::: {.panel head=Panel1}
Panel1 contents ...
:::
::: {.panel head=Panel2}
![Snapshot](./snapshot.png)
:::
We can also use headings (H1
up to H5
) as the head/title of the panel, which will be useful if you want to put the headings in TOC.
Panel1 contents …
A collection of panel
s will be automatically formed a tab or accordion sets. However, they have to be adjacent. Otherwise, they will be built as separate sets of tabs or accordions.
Panel1 contents
Panel2 contents
This panel will be hidden in TOC, as I used: ::: {.panel head=Panel2}
Panel3 contents
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
The quick brown fox jumps over the lazy dog.
::: {.panel .accordion head=Panel1}
The quick brown fox jumps over the lazy dog.
:::
::: {.panel head=Panel2}
panel2
:::