md-react-docgen

    1.1.1 • Public • Published

    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! ❤️ 💖 ❤️

    Install

    npm i md-react-docgen

    DownloadsWeekly Downloads

    2

    Version

    1.1.1

    License

    MIT

    Last publish

    Collaborators

    • marborkowski.react