README.md (view raw)
1<h1 align="center">
2 <img width="400" src="https://xix.ph0x.me/vitelogo.png" alt="Vite">
3</h1>
4
5> A simple and mnml static site generator; pronounced as /vit/
6
7Usage
8-----
9
10```console
11$ vite.py new <project-path>
12```
13
14Write your Markdown files in the `pages` directory and execute
15
16```console
17$ vite.py build <project-path>
18```
19
20**OR**
21
22```console
23$ vite.py build . # to build the current directory
24```
25
26Rendered HTML will be in the `build` directory.
27
28Configuration
29-------------
30
31Not very sophisticated, but basic configuration can be acheived using
32 `config.py` found in the project directory.
33Example config:
34
35```python
36# config.py
37title = ''
38author = ''
39header = ''
40footer = ''
41template = 'index.html' # default is index.html
42```
43
44Templating
45----------
46
47Vite uses Jinja2 templating. A basic example would be:
48
49```html
50<title> {{ title }} </title>
51
52<body>
53{{ body }}
54</body>
55
56<footer>
57{{ footer }}
58</footer>
59```
60
61Directory tree
62--------------
63
64 example
65 ├── build
66 │ └── test_page1
67 │ └── index.html
68 ├── config.py
69 ├── make.py -> /home/icyphox/code/vite/make.py
70 ├── pages
71 │ └── test_page1.md
72 └── templates
73 └── index.html
74
75TODO
76----
77
78- [x] Templating
79- [ ] CSS support
80- [ ] Implement a simple HTTP server (*later*)
81- [x] Add example site
82- [x] Basic config (`config.py`)
83
84
85## Credits
86_Logo credits_: <a href="http://www.freepik.com" title="Freepik">Freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a> is licensed by <a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0" target="_blank">CC 3.0 BY</a>
87_Hue_: [UltimateHackers/hue](https://github.com/UltimateHackers/hue)
88