1 | ![Grayson Logo](assets/Grayson-Logo.png)
|
2 | ***Static Site Generator***
|
3 |
|
4 | ### Installation
|
5 | ```
|
6 | npm install -g @earthtone/grayson-generator
|
7 | ```
|
8 |
|
9 | ### Usage
|
10 |
|
11 | Scaffold project directory structure
|
12 |
|
13 | ```
|
14 | grayson init [project-directory]
|
15 |
|
16 | ```
|
17 |
|
18 | ![sample output](assets/output.png)
|
19 |
|
20 | Generate HTML files from MD & JSON files
|
21 |
|
22 | ```
|
23 | grayson gen <project-directory> [output-directory] [pages-directory] [meta-directory]
|
24 |
|
25 | ```
|
26 |
|
27 | Traverses `pages` directory and `meta` directory for files. Both the source directories and output directories are configurable, but generation defaults to an assumed structure generated during `grayson init`. If no page specific metadata is provided, default values are used.
|
28 |
|
29 | EG: The files `/pages/index.md` & `/meta/index.json` yield an `index.html` file output in the `/public` directory.
|