npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ifuture/listify

v1.0.2

Published

Auto generate table of contents at full-site

Downloads

49

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

ifutureifuture

Keywords

Readme

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

✨ Example

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 :fire:

Author

👤 ifuture

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2019 ifuture. This project is MIT licensed.

Thanks

readme-md-generator ❤️