Skip to content

Commit

Permalink
ReadMe updated
Browse files Browse the repository at this point in the history
  • Loading branch information
MichelBoucey committed Dec 5, 2024
1 parent a7a241f commit e69d1d2
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions ReadMe.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<h1>Dumber</h1>
# Dumber

`dumber`, a (not so dumb) command line tool for **d**(igital n)**umber**(ing) Markdown document sections and creation of table(s) of contents accordingly.

With `dumber` (you already use `git`, don't you?) you can *add* or *remove* to your Mardown files:

- section numbers to header sections. This works on hash sign only, so one can exclude HTML section tags, as &lt;H1&gt;, to stay unnumbered.
- section numbers to header sections. This works on hash sign only. &lt;H1&gt;, (#) stay unnumbered as the main title.
- a table of contents with links on entries.

See an [example](./example.md).
Expand Down Expand Up @@ -35,11 +35,7 @@ Usage: dumber [OPTION] FILE
To add a table of contents you have to add a line with the HTML comment **&lt;!-- Toc --!&gt;**, where you want a table of contents to appear:

```
<!-- ToC -->
- [1.](#1-installation) Installation
- [2.](#2-usage) Usage
- [2.1.](#21-options) Options
- [2.2.](#22-add-table(s)-of-content) Add table(s) of content
&lt;!-- ToC --&gt;
```

The table of contents will be written just after the HTML comment line. And you can add this comment line as many times as you want, if you are, like me, a big fan of tables of contents, or if the length of your document needs a second table of contents at its end.
Expand Down

0 comments on commit e69d1d2

Please sign in to comment.