---

title: Readme.com - Minimal website generator copyright: Diego Caponera links: github: https://github.com/moonwave99/readme.com

Readme.com

From README.md
to index.html in one touch

---

Installation

Install it globally:

npm i -g readme.com

And the readme command will be available.

---

Documentation

Command Line

readme

generates the html

Options:
  --help          Show help                                            [boolean]
  --version       Show version number                                  [boolean]
  --readmePath    README path               [default: "{process.cwd}/README.md"]
  --distPath      dist path                           [default: "{process.cwd}"]
  --templatePath  custom templates path

---

Examples

• this page!
• homepage example