semvec/pypi-packages huggingface dataset:
sg1 0.1.4
A stupid, simple, static site generator
License: MIT
Requires Python: >=3.6, <4
Keywords: SIMPLE,STATIC,SITE,GENERATOR

Stupid Simple Static Site Generator
===================================

This repo is a stupid, simple, static site generator. It is very
opinionated, but you can easily create static sites with jinja templates
and json files. This basically cuts the framework out of rendering.

Getting Started
---------------

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:

.. code:: json

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

.. code:: json

   {
     ...,
     "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``.

To Do
-----

-  ☒ Add ``extras`` field to context files that automagically includes
   context of a specified subfolder (to easily use context from
   ``example_post.json`` to render the image and title in ``index.html``
   for example).
-  ☐ Pagination of extra
-  ☐ Refactor and general cleanup
-  ☐ Update paths for Windows

.. _jinja2: https://palletsprojects.com/p/jinja/
.. _jinja2 documentation: https://palletsprojects.com/p/jinja/
.. _PyPi: https://pypi.org/project/sg1/