Skip to main content

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-GPL%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.

### Docker

If you don’t want to install monopati through pip there is also the option of using docker:

` docker pull comzeradd/monopati docker run -t -v "$(pwd):/app" -u $(id -u):$(id -g) comzeradd/monopati monopati render `

### 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.

## Contribute

Development is mostly happening in the [Codeberg repository](https://codeberg.org/comzeradd/monopati).

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

monopati-0.3.3.tar.gz (2.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

monopati-0.3.3-py3-none-any.whl (2.9 MB view details)

Uploaded Python 3

File details

Details for the file monopati-0.3.3.tar.gz.

File metadata

  • Download URL: monopati-0.3.3.tar.gz
  • Upload date:
  • Size: 2.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for monopati-0.3.3.tar.gz
Algorithm Hash digest
SHA256 6cc419630490bcecb49cd28c96b81e3bc7ee968a38f51ce608bd17b2d7a184da
MD5 c217fec2591f639be1d58d8d4c60d76a
BLAKE2b-256 ba86ffc5e1c90aeacb14a4c8c470facc107117d8fddc6f02b17a96a71174e791

See more details on using hashes here.

File details

Details for the file monopati-0.3.3-py3-none-any.whl.

File metadata

  • Download URL: monopati-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 2.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for monopati-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 85337c5c54fdbf659db8bbf501938fbfac6189de311b5ad5707e20d718671dce
MD5 da79cc7e1b0e7a11980dad6aa8c4a0ec
BLAKE2b-256 59570ab55e6f62aef8b44689b627a6395ed776c1b644781da942eeb98167377f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page