From a402594fe8dd2e219ff6c9d1a6dbad09ccba3569 Mon Sep 17 00:00:00 2001 From: Nicola Fontana Date: Thu, 4 May 2023 08:16:10 +0200 Subject: [PATCH] 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 --- README.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d0ea2037..80da8c46 100644 --- a/README.md +++ b/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