Static site generator, and more...
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
documentation
lib
template
tests
.gitignore
.jshintrc
.npmignore
.travis.yml
LICENSE
README.md
index.js
package-lock.json
package.json
vegetables.json
vegetables.yml

README.md

Vegetables

A CLI tool to generate static Web pages from Markdown documents.

It is also designed to display/serve your documentation wiki pages in different formats.

Overview

Vegetables cool features:

  • a Markdown document can be converted into multiple formats (HTML, slideshow, ...)
  • serve mode to preview or serve locally the generated pages
  • automatic page reload in serve mode
  • deploy command to create automatically project documentation on GitHub pages
  • non intrusive per page configuration, centralized in the configuration file
  • however, YAML (or JSON) frontmatter is supported
  • gollum partially compatible
  • easy to write templates
  • a lot of tags for templates

The documentation

Read the documentation (generated with Vegetables, of course) for further details.

License