Browse Source

updated readme

master
hex 3 years ago
parent
commit
e32c33de4f
1 changed files with 10 additions and 0 deletions
  1. 10
    0
      readme.md

+ 10
- 0
readme.md View File

@@ -5,8 +5,11 @@ Your project should look like this.
```
stagen.py
templates/{templates}.html
templates/post.html
templates/posts.html
content/{html files here}.html
output/
posts/{posts}.md
```

An easy way to install this is checkout
@@ -20,6 +23,13 @@ templates in the `templates` folder but these are not
automatically processed. Refer to the Jinja2
docs for more info.

For posts, the post.html file is used when processing a
post in markdown format, and posts.html is used for
displaying the list of posts.

More documentation on that in the future but for now
just make sure those files exist or it'll get mad at you

EXAMPLE

`templates/page.html`

Loading…
Cancel
Save