0.8.0 • Published 4 years ago
marshmallow v0.8.0
README Parser – easy as marshmallow!
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
-t, --url Set homepage
-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.
0.8.0
4 years ago
0.6.2
4 years ago
0.7.0
4 years ago
0.6.1
5 years ago
0.6.0
5 years ago
0.5.5
5 years ago
0.5.4
6 years ago
0.5.3
6 years ago
0.5.2
6 years ago
0.5.1
6 years ago
0.5.0
6 years ago
0.4.0
6 years ago
0.3.2
6 years ago
0.3.1
6 years ago
0.2.2
6 years ago
0.2.1
6 years ago
0.2.0
6 years ago
0.0.0
6 years ago
0.1.1
11 years ago
0.1.0
11 years ago