a minimalistic static content generator
Project description
# monopati
A minimalistic static content generator.
You can read the [relevant post](https://www.roussos.cc/2016/01/11/monopati/) on why I started building this. Monopati is inspired by other great minimalistic content generators, like [bucket3](https://github.com/vrypan/bucket3/) and [habu](https://github.com/botherder/habu).
[![license](https://img.shields.io/badge/license-AGPL%203.0-6672D8.svg)](LICENSE)
## Usage
Install from pypi:
` sudo pip install monopati `
On first run create the website folder:
` monopati --path=mywebsite init `
This will create a folder named mywebsite. Inside that folder there is a configuration example file that you should copy and edit to meet your needs.
` cd mywebsite cp config.yml.dist config.yml `
Finally, build your website:
` monopati render `
This will generate all necessary files for serving the website, under the folder you picked as output in your configuration file.
### Structure
Use posts, pages folders for blog and static content respectively.
Use templates for adjusting UI to fit your needs. [Jinja2](http://jinja.pocoo.org/) template engine is being used for both templates and pages. [Markdown](https://en.wikipedia.org/wiki/Markdown) for blog posts.
### Example
The code comes with one example post (under the posts) folder. You can check how the metadata header is being user and some basic syntax and how images can be added to a post. Under the pages folder there is a static template example which serves as the landing and about page of your site.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file monopati-0.3.0.tar.gz
.
File metadata
- Download URL: monopati-0.3.0.tar.gz
- Upload date:
- Size: 2.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.6.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ebe3b1c113f658ca03920ce708881ce394bb04fbc7f078d60b0ceb88c3cd3cd7 |
|
MD5 | 1cd389489adbab7858d3ffb16cad54bc |
|
BLAKE2b-256 | f35637d8a88f76802f1b73a29f31095f82a209db195882ad436d54dfb008eeb3 |
File details
Details for the file monopati-0.3.0-py3-none-any.whl
.
File metadata
- Download URL: monopati-0.3.0-py3-none-any.whl
- Upload date:
- Size: 2.8 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.6.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3493b04190146f1ec20a96f14df54298c5cc1890b3ac08829216b7338eb1452e |
|
MD5 | cb1e6e5466dc31df8b4a330cbd829a90 |
|
BLAKE2b-256 | a2e91f9d7b9237de4dca0356bc1ee9c79e85074a5f1787f892a55eb005fd7c7e |