https://github.com/niquenen/gfm-toc
Simple tool to create a TOC (table of contents) and compliant with GitHub Flavored Markdown (GFM).
https://github.com/niquenen/gfm-toc
github-flavored-markdown nodejs npm toc
Last synced: 23 days ago
JSON representation
Simple tool to create a TOC (table of contents) and compliant with GitHub Flavored Markdown (GFM).
- Host: GitHub
- URL: https://github.com/niquenen/gfm-toc
- Owner: niquenen
- License: mit
- Created: 2024-09-04T12:06:45.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-01T21:11:56.000Z (over 1 year ago)
- Last Synced: 2025-01-29T15:12:32.864Z (over 1 year ago)
- Topics: github-flavored-markdown, nodejs, npm, toc
- Language: TypeScript
- Homepage: https://niquenen.github.io/gfm-toc/
- Size: 69.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gfm-toc
Simple tool to create a TOC (table of contents) and compliant with GitHub
Flavored Markdown (GFM).
## Install
Install with [npm](https://www.npmjs.com/).
1. Add registry in [.npmrc config file](
https://docs.npmjs.com/cli/configuring-npm/npmrc
).
```ini
@niquenen:registry=https://npm.pkg.github.com
```
2. Install the npm package.
```sh
npm install --global @niquenen/gfm-toc
```
3. Use gfm-toc.
```sh
gfm-toc
```
## Contributing
Pull requests are always welcome. For bugs and feature requests,
please [create an issue](https://github.com/niquenen/gfm-toc/issues).