sg1 0.1.4

Install

To install from PyPi :

pip3 install sg1

Setup

sg1 start projectname

This creates 3 folders in a directory projectname:

1. templates: These are the jinja2 templates that will be rendered.

2. content: JSON files that specify the key value pairs used to render the templates.

3. html: Output directory of the rendering. This is where your beautifully* rendered html files are generated.

*Beauty not guaranteed.

Templates

See the jinja2 documentation

Content

Example:

# index.json

 {
     "template": "index.html",
     "title": "I'm a title"
     "p": "I'm a paragraph."
     "extras": [
       "about/about.json",
       "posts"
     ]
     ...
}

The only required field is template which is the relative path from the templates folder.

The rest is whatever you want, just make sure the variables are in the template ({{ content.variable }}).

Simple URLs

sg1 urls projectname creates a urls folder in projectname with a urls.json file containing all the project urls for ease of use in the templates.

Example:

Let’s say you have a content file posts/post.json. The above command will add relative reference in the urls.json file like:

{
  ...,
  "posts__post": "/posts/post.html",
  ...
}

You can then create a link in the template with <a href="{{ urls.posts__post }}">Post</a>.

HTML

To generate the HTML files, run sg1 render projectname.