vite
A simple and mnml static site generator that Just Works™
NOTE: Ths project has been superseded by go-vite.
Installation
$ pip install git+https://github.com/icyphox/vite
Note: the PyPI version is out of date, and likely won’t be updated. I can’t be bothered.
Usage
$ vite init path/to/project
$ vite new blog/some-post.md # `pages/` is implied
This creates pages/blog/some-post.md.
And then:
$ vite build # in project directory
Rendered HTML will be in the build directory.
Finally, run:
$ vite serve # also in the project directory
Configuration
Not very sophisticated, but basic configuration can be acheived using
config.py found in the project directory.
Example config:
# config.py
title = ''
author = ''
header = ''
footer = ''
template = 'index.html' # default is templates/index.html
pre_build = [] # list of commands to run pre-build
post_build = [] # list of commands to run post-build
Templating
Vite uses Jinja2 templating, so template files must be placed in a separate templates/ directory.
A basic example would be:
<link rel="stylesheet" href="/static/sakura-earthy.css">
<title> {{ title }} </title>
<body>
{{ body }}
</body>
<footer>
{{ footer }}
</footer>
Specifying per-page templates
Vite allows for specifying a unique template, per page. This is acheived by including YAML frontmatter at the top of the Markdown file, like so:
---
template: foo.html
title: Some fancy buzzwords here
subtitle: Cool catch phrase here
url: my-post
date: 2019-08-09
---
## markdown here
...
Notes on templating
- Stylesheets, images and JS can be accessed from the
staticfolder. index.html, i.e. your website’s homepage, should be_index.mdin thepages/directory.
Directory tree
example
├── build
├── config.py
├── pages
│ └── test.md
├── static
└── templates
└── index.html
TODO
- [x] Templating
- [x] CSS support
- [x] Implement a simple HTTP server (later)
- [x] Add example site
- [x] Basic config (
config.py) - [x] Parsing frontmatter (JSON, YAML, TOML) for per-page options
- [x] Better support for home page (main
index.htmlpage) - [x] More powerful frontmatter (title, date, draft status, etc.) (draft status is incomplete)
- [ ] ~Deeper directories under
pages/(supports only one level now, breaks otherwise)~ (not happening) - [ ] ~Tagging system~ (not happening)