https://github.com/michelboucey/dumber
Automatic (un)numbering Markdown sections & creation/removal of ToC
https://github.com/michelboucey/dumber
command-line-tool editing markdown section-headers table-of-contents
Last synced: 3 months ago
JSON representation
Automatic (un)numbering Markdown sections & creation/removal of ToC
- Host: GitHub
- URL: https://github.com/michelboucey/dumber
- Owner: MichelBoucey
- License: other
- Created: 2021-03-12T23:46:05.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-05T10:38:27.000Z (6 months ago)
- Last Synced: 2024-12-26T10:13:31.661Z (5 months ago)
- Topics: command-line-tool, editing, markdown, section-headers, table-of-contents
- Language: Go
- Homepage:
- Size: 52.7 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: ReadMe.md
- License: LICENSE
Awesome Lists containing this project
README
# 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. <H1> (#) stays unnumbered as the main title.
- a table of contents with links on entries.
See an [example](./example.md).
_N.B._ : The table of contents generation is not tested nor implemented for UTF8 yet.
## 1. Installation
```
make install
```
## 2. Usage
### 2.1. Command line options
```
user@machine $ dumber -h
Usage: dumber [OPTION] FILE
-h Show help
-r Remove section numbers and table of contents from the .md file
-v Show version
-w Write section numbers to the .md file (default to stdout)
```
### 2.2. Add table(s) of contents
To add a table of contents you have to add a line with the HTML comment **<!-- Toc --!>**, where you want a table of contents to appear:
```
```
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.