mdxprograms/paqrat

A flask site that compiles to static

paqrat

currently a work in progress

A flask site that compiles to static

Requirements

• python3

Getting started

• make setup
• make dev

How it works

Data in /data will be associated with the data variable in all pages.

Each data file is added to the data dict and it's associated filename is added as a key to it's data varaiables

The only exception is anything in config.yml will be under data.site.

ie: {{ data.site.title }} would be associated with config.yml

Content

Basic content entries are under /content.

You can pass an array of content files to use in your route template: get_content(['index, about']) This will apply it to the templates content variable {{ content.index }} {{ content.about }} This allows for separating content into any markdown file in /content and using it in multiple areas and templates.

Routing

A basic route is defined by 4 things:

1. route => "/"
2. template => index.html
3. data => get_data()
4. content => get_content(['index', 'about'])

# example values

@app.route(route)
def index():
    return render_template(template,
                           content=get_content(content),
                           data=data)

Build

make build

This will create a build directory with static files ready for deployment.

paqrat's Issues

Move build static to lib and add to makefile

Automate process with makefile

Add documentation on how to host

Add modern asset compilation

https://flask-assets.readthedocs.io/en/latest/

Dynamically generate routes