Add automatic TOC to README.md
Manually maintaining the table of contents relies on how HTML fragments
are generated, it is prone to errors (infact it is already out of sync)
and just plain boring.
Unfortunately there is no common agreement on all markdown flavours on
how the table of contents must be implemented. Here the `[[_TOC_]]` tag
has been used because it is supported by both GitLab and GitHub:
https://gitlab.com/gitlab-org/gitlab/-/issues/21901
This commit is contained in:
parent
7fef7573e6
commit
a402594fe8
10
README.md
10
README.md
|
|
@ -1,14 +1,8 @@
|
|||
This is the README file of the IgH EtherCAT Master.
|
||||
|
||||
vim: spelllang=en spell tw=78
|
||||
|
||||
Contents:
|
||||
- [General Information](#general-information)
|
||||
- [Requirements](#requirements)
|
||||
- [Building and Installing](#building-and-installing)
|
||||
- [Realtime and Tuning](#realtime-and-tuning)
|
||||
- [License](#license)
|
||||
- [Coding Style](#coding-style)
|
||||
|
||||
[[_TOC_]]
|
||||
|
||||
# General Information
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue