A simple and minimal static site generator.
Project description
<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/
[](https://forthebadge.com)
[](https://forthebadge.com)
[](https://forthebadge.com)
[](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)
<img width="400" src="https://xix.ph0x.me/vitelogo.png" alt="Vite">
</h1>
> A simple and mnml static site generator; pronounced as /vit/
[](https://forthebadge.com)
[](https://forthebadge.com)
[](https://forthebadge.com)
[](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)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
vite-1.2-py3-none-any.whl
(6.4 kB
view hashes)
