README.md (view raw)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
Vite ==== > A simple and mnml static site generator; pronounced as /vit/ Usage ----- ``` {.sourceCode .console} $ vite.py new <project-path> ``` Write your Markdown files in the `pages` directory and execute ``` {.sourceCode .console} $ vite.py build <project-path> ``` **OR** ``` {.sourceCode .console} $ make.py # at the project directory ``` Rendered HTML will be in the `build` directory. Configuration ------------- | Not very sophisticated, but basic configuration can be acheived using `config.py` found in the project directory. | Example config: ``` {.sourceCode .python} # config.py title = '' author = '' header = '' footer = '' ``` Templating ---------- Vite uses Jinja2 templating. A basic example would be: ``` {.sourceCode .html} <title> {{ title }} </title> <body> {{ body }} </body> <footer> {{ footer }} </footer> ``` Directory tree -------------- example ├── build │ └── test_page1 │ └── index.html ├── config.py ├── make.py -> /home/icyphox/code/vite/make.py ├── pages │ └── test_page1.md └── templates └── index.html TODO ---- - [x] Templating - [ ] CSS support - [ ] Implement a simple HTTP server (*later*) - [x] Add example site - [x] Basic config (`config.py`) |