Metadata-Version: 2.4
Name: monopati
Version: 0.3.3
Summary: a minimalistic static content generator
Home-page: https://codeberg.org/comzeradd/monopati
Author: Nikos Roussos
Author-email: nikos@roussos.cc
License: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
License-File: LICENSE
Requires-Dist: docopt
Requires-Dist: Jinja2
Requires-Dist: Markdown
Requires-Dist: PyYAML
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

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