node package manager

marshmallow

README Parser – easy as marshmallow!

README Parser – easy as marshmallow!

Travis Status AppVeyor Status Codacy Status Dependencies Status Version Status Download Status Gitter Chat

Why it's awesome

Marshmallow create a minimalist documentation using Milligram. Ease to use. No config. No headache. Parser README.md to index.html so easy to prepare as marshmallow!

Install

Install with npm

$ npm install marshmallow

Install with Yarn

$ yarn add marshmallow

Run with npx (without installing!)

npx marshmallow

Usage

    Usage:

        $ marshmallow [<options>]

    Options:

        -h, --help              Display help information
        -v, --version           Output version
        -o, --output            Set output
        -r, --readme            Set README.md file
        -m, --minify            Minify HTML
        -i, --image             Set image
        -t, --title             Set title
        -d, --description       Set description
        -t, --color             Set color theme
        -f, --force             Force overwrite

    Examples:

        $ marshmallow
        $ marshmallow --output documentation // documentation/index.html
        $ marshmallow --output docs/index.html

    Default settings when no options:

        $ marshmallow --output index.html --readme README.md --minify true

Note: Has PSD support.

Contributing

Want to contribute? Follow these recommendations.

License

Designed with ♥ by CJ Patoilo. Licensed under the MIT License.