https://github.com/ngn13/mdindex
script to create index (catalog) from markdown headers
https://github.com/ngn13/mdindex
markdown-index markdown-index-generator
Last synced: 3 months ago
JSON representation
script to create index (catalog) from markdown headers
- Host: GitHub
- URL: https://github.com/ngn13/mdindex
- Owner: ngn13
- License: gpl-3.0
- Created: 2024-05-19T00:23:07.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-19T00:34:28.000Z (about 1 year ago)
- Last Synced: 2025-01-21T06:11:35.414Z (4 months ago)
- Topics: markdown-index, markdown-index-generator
- Language: Python
- Homepage:
- Size: 159 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# mdindex
simple python script to create index (catalog) from markdown headers,
like the emacs org mode
## install
simply just clone the repo and run make as root to install the script
to your `PATH`:
```bash
git clone https://github.com/ngn13/mdindex.git
cd mdindex && sudo make
```
## usage
simply just specify the markdown file path, script will auto generate
the index and append it at the beginning of the file:
```bash
mdindex my/cool/notes.md
```