markade

A static site generator using Pug, Markdown and YAML

Installation

  npm install -g markade

Usage

  markade -h
    init [directory]                Initialize a markade directory
    compile [directory]             Compiles a markade directory
    watch [options] [directory]     Watches for changes and sets up a dev server

Init

1. (Optional) Make a new directory.
2. To initialize, run markade init <directory>. This will create a markade.json file and copy over the sample templates and data.
3. You can edit the markade.json file as you wish, such as the paths for outut, template or data.

Compile

1. (Optional) Move into your directory.
2. To compile, run markade compile <directory>. This will look for markade.json you created earlier then look for data files in the data directory you specified and compare them against the templates in the following way:
3. A YAML variable template: file.jade specified.
4. Templates defined in your markade.json in a templates object. "templates": {"file.jade": "file.md"}
5. If none found, it defaults to a file with the same name in the template directory.
6. Then it will write the file in the same relative path as your data file in your output directory in the following way:
7. A YAML variable output: file.xml specified.
8. The same name and relative path as your data file: data/about/index.md -> public/about/index.html.

Watch and Server

1. To watch for changes and run a server, run markade watch <directory>

License

MIT © Ilias Ismanalijev