Skip to main content

Static site generator

Project description


Yet another static website generator, with plugin support.

Used by (www|blog) to convert Markdown and Jinja2 into HTML.


$ pip install stone-site


To get started with stone:

# Create template layout
stone example_site init --site-name ''
# Generate site
stone example_site generate
# Add a new page
stone example_site newpage --name "About Us"

By default Stone is configured to turn Markdown + YAML metadata + Jinja2 templates into HTML but as it has support for custom plugins it can generate anything it has code for.

Site Configuration

Configuration File

Stone generates sites based on the contents of site.json. Each site can specify which backends, generators and renderers to use, custom versions will be loaded from the $HOME/.stone directory.


An example project that generates an example landing page and blog is included in Stone’s project source. you can build it by running:

stone example generate

Folder Structure

Stone was originally designed to generate the subdomains of The following is the layout of the sites:

├── blog
   └── ...
├── main
   └── ...
├── site.json
└── templates
    └── ...

site.json is flexiable about the location of templates and files. As such your not constrained to any particular layout for your site. You could have separate template folders inside each site or one shared in the project root. Each site can specify its template directory


By default pages are Markdown file, that can have optional YAML metadata that describe the attributes of the page including the title and which template to uses. For example:

template: base.html
title: Hello, World

# This is a header

Here is some lovely content.

Stone makes all metadata available to page templates. Any data templates may use can be embedded into a page. For exampled: an author’s name, email, the date the page was written. The behaviour is dependent on the generator and renderers used. See the [renderers](docs/ and [generators](docs/ for more details.


By default templates are HTML pages with jinja2 markup.


    {% block head %}
    <title>{{ title }}</title>
    {% endblock %}
  {% block body %}
    <h1>{{ title }}</title>
    <div id="post">
      <!-- Most likely we are going to pass more html here --->
      {{ content|safe }}
  {% endblock %}


To generate a particular site invoke stone with the location of the project’s root folder.

stone root_folder generate

Backends - File

The file backend will write out each file to the specified target path.

Backends - S3

The S3 backend will upload each object to the specified bucket. Currently only html pages are supported, they will be gzipped and have a default caching time of 1 hour.

The minimum required for this backend is:

"backends": [
    "type": "s3",
    "bucket": "",

The full range of options is:

"backends": [
    "type": "s3",
    "bucket": "",
    "prefix": "website"
    "cache-controller": "max-age:360",
    "content-language": "en-GB",
    "metadata": {
      "key": "value"
    "tags": {
      "key", "value"

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

stone-site-0.1.8.tar.gz (12.4 kB view hashes)

Uploaded source

Built Distribution

stone_site-0.1.8-py2.py3-none-any.whl (16.0 kB view hashes)

Uploaded 3 7

Supported by

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