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 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
<h1 align="center"> <img width="400" src="https://xix.ph0x.me/vitelogo.png" alt="Vite"> </h1> > A simple and mnml static site generator; pronounced as /vit/ [![forthebadge](https://forthebadge.com/images/badges/60-percent-of-the-time-works-every-time.svg)](https://forthebadge.com) [![forthebadge](https://forthebadge.com/images/badges/made-with-python.svg)](https://forthebadge.com) [![forthebadge](https://forthebadge.com/images/badges/powered-by-electricity.svg)](https://forthebadge.com) [![forthebadge](https://forthebadge.com/images/badges/uses-git.svg)](https://forthebadge.com) Installation ------------ Clone this repo and: ```console $ pip install . # in the cloned directory ``` Usage ----- ```console $ vite new <project-path> ``` Write your Markdown files in the `pages` directory and execute: ```console $ vite build # in project directory ``` Rendered HTML will be in the `build` directory. Finally, run: ```console $ vite serve # also in the project directory ``` to serve the contents of the `build` directory. Configuration ------------- Not very sophisticated, but basic configuration can be acheived using `config.py` found in the project directory. Example config: ```python # config.py title = '' author = '' header = '' footer = '' template = 'index.html' # default is index.html ``` Templating ---------- Vite uses Jinja2 templating. **NOTE**: Stylesheets, images and JS can be accessed from the `static` folder. A basic example would be: ```html <link rel="stylesheet" href="../static/sakura-earthy.css"> <title> {{ title }} </title> <body> {{ body }} </body> <footer> {{ footer }} </footer> ``` 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`) ## Credits _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> _Hue_: [UltimateHackers/hue](https://github.com/UltimateHackers/hue) |