Welcome to Rost’s documentation!

Rost is a simple static site generator based on Jinja2 with a command line interface build using Click.

Get started with Installation and then get a quick overview with the Quickstart section. There is also a Advanced Usage section that covers some of rost’s more advanced features.

Overview

Rost’s feature highlights include:

• Includes a simple CLI tool to (re)generate your site build using Click.

• Includes support for monitor your source directory for changes, and regenerates your site if they change.

• Includes a developments server.

• It also includes support for LiveReload.

Documentation

This part of the documentation guides you through all of the library’s usage patterns.

• Installation
  • Living on the edge
  • Upgrade
  • How to invoke rost?
• Quickstart
  • Create a skeleton project
  • Rendering templates with the rost CLI
  • Starting a development server
  • Getting help on version, commands and option names
  • Next Steps
• Advanced Usage
  • Using Custom Build Scripts
  • Loading Data
  • Custom Filters
• API Documentation
  • Public API
  • Private API
• CLI Documentation
  • Invocation
  • Commands
• Changelog
  • 0.1.0
• License
  • License Text

Useful Links:

• Source Code
• PyPi Release

Indices and tables

• Index

• Module Index

• Search Page