ifuture-pro / listify

Generate and merge table of contents for markdown file . Add it to README.md or other files

Welcome to listify 👋

Auto generate table of contents
Generate and merge all directories to the specified file.

✨ Example

• Demo
• Example with Docsify

Install

npm install @ifuture/listify -g

Usage

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 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 🔥

Author

👤 ifuture

• Website: https://ifuture.pro
• Github: @ifuture-pro

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2019 ifuture.
This project is MIT licensed.

---

Thanks

readme-md-generator ❤️