Skip to content

Commit

Permalink
Show what features can generate
Browse files Browse the repository at this point in the history
  • Loading branch information
Moonbase59 committed Apr 6, 2024
1 parent 874eaf9 commit 8747842
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
# <a name="gh-toc"></a>gh-toc <a href="#toc" class="goToc">↑</a>
```

**Generated Markdown using _Anchors: {#…}_ and _BL: ↑ToC_:**

```markdown
# gh-toc <a href="#toc" class="goToc">↑</a> {#gh-toc}
```

## Known problems

- ~~_gh-toc_ will "brute-force replace" all text between the ToC start marker `<!-- ToC begin -->` and the end marker `<!-- ToC end -->` 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.~~
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
<h1>gh-toc</h1>
<p>Quickly create Table-of-Content Markdown for GitHub Markdown files. (<a href="https://github.com/moonbase59/gh-toc">Source code</a>)</p>
<blockquote><em>I could never find a <strong>do-it-all</strong>, 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.</em></blockquote>
<p>Indeed. This fork has bugfixes and lots of <em>additional features:</em></p>
<p>Indeed. This began as a fork and has meanwhile evolved to a <em>full-fledged solution</em>:</p>
<ul>
<li>Full Unicode support, all international characters.</li>
<li>Much better code block support (indented, backticks, tildes, different number of backticks/tildes).</li>
Expand Down

0 comments on commit 8747842

Please sign in to comment.