https://github.com/ifuture-pro/listify
Generate and merge table of contents for markdown file . Add it to README.md or other files
https://github.com/ifuture-pro/listify
blog directory document list-of-contents listify markdown table-of-contents
Last synced: 3 months ago
JSON representation
Generate and merge table of contents for markdown file . Add it to README.md or other files
- Host: GitHub
- URL: https://github.com/ifuture-pro/listify
- Owner: ifuture-pro
- License: mit
- Created: 2019-11-16T05:51:56.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-07T07:21:03.000Z (almost 2 years ago)
- Last Synced: 2024-11-04T19:42:27.048Z (4 months ago)
- Topics: blog, directory, document, list-of-contents, listify, markdown, table-of-contents
- Language: JavaScript
- Homepage:
- Size: 85 KB
- Stars: 10
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Welcome to listify 👋
> Auto generate table of contents
> Generate and merge all directories to the specified file.
### ✨ Example
* [Demo](demo/README.md)
* [Example with Docsify](https://developer.ifuture.pro/)
## Install
```sh
npm install @ifuture/listify -g
```
## Usage
```sh
listify ./
```
**options**
- `--out` Result out file. Default: work dir README.md
- `--maxlevel` Header level. Default: 4
- `--title` The Title of list
- `--containroot` Contain root path.When linked in local,change it `true`.Default: `false`
- `--suffix` contain file suffix in out file.Default: `false`
- `--exclude` Exclude files.
e.g.
Ignore multi file `--exclude a.md --exclude b.md `
Support regexp. Ignore start with `_` `--exclude='^_\S*'`
- `--blog` parse YAML `frontmatter` block in the Markdown file.
Front matter options `title`,`publish`
- `--package` Parent directory as the first header
- `--single` Directories in single. Default:false
- `--merge` Merge directories. Default:true
- `--exclude_dir` Exclude dir.
## Github actions
[GitHub Actions](https://github.com/features/actions) makes it easy to automate all your software workflows, now with world-class CI/CD. Build, test, and deploy your code right from GitHub. Make code reviews, branch management, and issue triaging work the way you want.
When you push document . It will generate list of contents to specified file.
[Marketplace](https://github.com/marketplace/actions/listify-actions) :fire:
## Author
👤 **ifuture**
* Website: https://ifuture.pro
* Github: [@ifuture-pro](https://github.com/ifuture-pro)
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2019 [ifuture](https://github.com/ifuture-pro).
This project is [MIT](https://github.com/ifuture-pro/listify/blob/master/LICENSE) licensed.
***
## Thanks
[readme-md-generator](https://github.com/kefranabg/readme-md-generator) ❤️