README.md (view raw)
1# Vite
2> A simple and mnml static site generator; pronounced as /vit/
3
4## Usage
5```console
6$ vite.py new <project-path>
7```
8Write your Markdown files in `pages/` and
9```console
10$ vite.py build <project-path>
11```
12
13*OR*
14
15```console
16$ make.py # at the project directory
17```
18Rendered HTML will be in `build/`
19
20## Configuration
21Not very sophisticated, but basic configuration can be acheived using `config.py` found in the project directory.
22Example config:
23```python
24# config.py
25title = ''
26author = ''
27header = ''
28footer = ''
29```
30
31## Templating
32Vite uses Jinja2 templating. A basic example would be:
33```html
34<title> {{ title }} </title>
35
36<body>
37{{ body }}
38</body>
39
40<footer>
41{{ footer }}
42</footer>
43```
44
45## TODO
46
47- [x] Templating
48- [ ] CSS support
49- [ ] Implement a simple HTTP server (_later_)
50- [x] Add example site
51- [x] Basic config (`config.py`)