https://github.com/cjpatoilo/marshmallow

README Parser – easy as marshmallow!
https://github.com/cjpatoilo/marshmallow

cli docs documentation-tool gh-pages markdown-to-html marshmallow

Last synced: 4 months ago
JSON representation

README Parser – easy as marshmallow!

• Host: GitHub
• URL: https://github.com/cjpatoilo/marshmallow
• Owner: cjpatoilo
• License: mit
• Created: 2018-02-12T20:35:21.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2023-02-27T01:23:26.000Z (over 3 years ago)
• Last Synced: 2025-10-21T02:35:19.773Z (8 months ago)
• Topics: cli, docs, documentation-tool, gh-pages, markdown-to-html, marshmallow
• Language: JavaScript
• Homepage: https://cjpatoilo.com/marshmallow
• Size: 428 KB
• Stars: 11
• Watchers: 0
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Contributing: .github/contributing.md
  • Funding: .github/funding.yml
  • License: license

Awesome Lists containing this project

• awesome-brasil - Marshmallow

README

          


> README Parser – easy as marshmallow!

[![Travis Status](https://travis-ci.org/cjpatoilo/marshmallow.svg?branch=master)](https://travis-ci.org/cjpatoilo/marshmallow?branch=master)

[![AppVeyor Status](https://ci.appveyor.com/api/projects/status/rq1lwhaea31u7sq9?svg=true)](https://ci.appveyor.com/project/cjpatoilo/marshmallow)

[![Codacy Status](https://img.shields.io/codacy/grade/e5fa9acbf7b14b92bdeef938112e4e3d/master.svg)](https://www.codacy.com/app/cjpatoilo/marshmallow/dashboard)

[![Dependencies Status](https://david-dm.org/cjpatoilo/marshmallow/status.svg)](https://david-dm.org/cjpatoilo/marshmallow)

[![Version Status](https://badge.fury.io/js/marshmallow.svg)](https://www.npmjs.com/package/marshmallow)

[![Download Status](https://img.shields.io/npm/dt/marshmallow.svg)](https://www.npmjs.com/package/marshmallow)

[![Gitter Chat](https://img.shields.io/badge/gitter-join_the_chat-4cc61e.svg)](https://gitter.im/cjpatoilo/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**

```sh

$ npm install marshmallow

```

**Install with Yarn**

```sh

$ yarn add marshmallow

```

**Run with npx (without installing)**

```sh

npx marshmallow

```

## Usage

```

Usage:

  $ marshmallow []

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](https://github.com/cjpatoilo/marshmallow/contribute).

## License

Designed with ♥ by [CJ Patoilo](https://twitter.com/cjpatoilo). Licensed under the [MIT License](https://cjpatoilo.com/license).