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

md-react-docgen

v1.1.1

Published

Generate simple React components documentation in Markdown

Downloads

6

Readme

simple-react-docgen

npm version dependency status build status

Generate simple React components documentation in Markdown.

Usage

Example:

$ simple-react-docgen src -o DOC.md

Check every option runnig simple-react-docgen with --help or -h:

$ simple-react-docgen --help

Usage: simple-react-docgen [paths]... [options]

paths     Component files or directories. If nothing is provided it reads from stdin.

Options:
   -x, --extension          File extensions to consider. Repeat to define multiple extensions. Default:  [js,jsx]
   -e, --exclude            Filename patterns to exclude. Default:  []
   -i, --ignore             Folders to ignore. Default:  [node_modules,__tests__,__mocks__]
   -o FILE, --output FILE   Markdown file to write. If nothing is provided it writes to stdout.

Create a markdown documentation from React components.
If a directory is passed, it is recursively traversed.

Contributing

First of all, thank you for wanting to help!

  1. Fork it.
  2. Create a feature branch - git checkout -b more_magic
  3. Add tests and make your changes
  4. Check if tests are ok - npm test
  5. Commit changes - git commit -am "Added more magic"
  6. Push to Github - git push origin more_magic
  7. Send a pull request! :heart: :sparkling_heart: :heart: