https://github.com/illyism/markade
:rocket: A markdown + jade + yaml static site generator
https://github.com/illyism/markade
generator javascript markdown site static watch yaml yaml-variable
Last synced: 11 months ago
JSON representation
:rocket: A markdown + jade + yaml static site generator
- Host: GitHub
- URL: https://github.com/illyism/markade
- Owner: Illyism
- License: mit
- Created: 2015-02-05T18:25:55.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2023-09-10T07:18:36.000Z (almost 3 years ago)
- Last Synced: 2025-07-01T08:54:37.626Z (12 months ago)
- Topics: generator, javascript, markdown, site, static, watch, yaml, yaml-variable
- Language: JavaScript
- Homepage: https://il.ly
- Size: 43.9 KB
- Stars: 14
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
**A static site generator using [Pug](https://github.com/pugjs/pug), [Markdown](https://help.github.com/articles/markdown-basics/) and [YAML](http://www.yaml.org/)**
## Installation
```bash
npm install -g markade
```
## Usage
```bash
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 `. 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 `. 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:
1. A YAML variable `template: file.jade` specified.
2. Templates defined in your markade.json in a templates object. `"templates": {"file.jade": "file.md"}`
3. If none found, it defaults to a file with the same name in the template directory.
3. Then it will write the file in the same relative path as your data file in your output directory in the following way:
1. A YAML variable `output: file.xml` specified.
2. 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 `
## License
MIT © [illyism](http://il.ly)