From 874784250496f7ef1730be433743ed03c2e3267c Mon Sep 17 00:00:00 2001 From: Moonbase59 Date: Sat, 6 Apr 2024 04:25:22 +0200 Subject: [PATCH] Show what features can generate --- README.md | 14 +++++++++++++- index.html | 2 +- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ed704a3..baf11aa 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Quickly create Table-of-Content Markdown for GitHub Markdown files. > I could never find a _**do-it-all**_, easy to use, online Table-of-Content maker for GitHub (and other) Markdown files. There were many solutions that required downloading or installing something on my computer. For such a trivial task I felt that was unnecessary. -Indeed. This [fork](https://imthenachoman.github.io/nGitHubTOC/) has bugfixes and lots of _additional features:_ +Indeed. This began as a [fork](https://imthenachoman.github.io/nGitHubTOC/) and has meanwhile evolved to a _full-fledged solution:_ - Full Unicode support, all international characters. - Better handling of (hopefully) all underscore cases. @@ -100,6 +100,18 @@ in the Markdown file, which Pandoc then converts to this HTML: Also try the other options, like auto-generated backlinks to ↑Top or ↑ToC next to each heading! Backlinks use CSS classes `goTop` and `goToc`, so you can even _style_ them! +**Generated Markdown using _Anchors: HTML_ and _BL: ↑ToC_:** + +```markdown +# gh-toc ↑ +``` + +**Generated Markdown using _Anchors: {#…}_ and _BL: ↑ToC_:** + +```markdown +# gh-toc ↑ {#gh-toc} +``` + ## Known problems - ~~_gh-toc_ will "brute-force replace" all text between the ToC start marker `` and the end marker `` with the new Table of Contents, _even if they are in a code block_. Avoid that for now, or don’t use the _Full MD_ option in this case and insert the ToC manually.~~ diff --git a/index.html b/index.html index 8df8757..41d02b3 100644 --- a/index.html +++ b/index.html @@ -65,7 +65,7 @@

gh-toc

Quickly create Table-of-Content Markdown for GitHub Markdown files. (Source code)

I could never find a do-it-all, easy to use, online Table-of-Content maker for GitHub (and other) Markdown files. There were many solutions that required downloading or installing something on my computer. For such a trivial task I felt that was unnecessary.
-

Indeed. This fork has bugfixes and lots of additional features:

+

Indeed. This began as a fork and has meanwhile evolved to a full-fledged solution: