Uriel Documentation

This is documentation for the Uriel static site generator.

The latest version of this documentation can be found online at documentation.uriel.foo, or bundled with the Uriel source code.

The documentation itself is presented in the form of a Uriel project. You can read it, of course. But you can also examine the project files and see how it was constructed. The project files themselves use most of the features of Uriel within this project.

If you want to view (and experiment with) this documentation locally, you will need to view it through a web server. See the README.md file in the documentation directory for instructions on viewing this documentation locally through the built-in web server that comes with Python.

Getting Started

Overview

Quick Start

Project Structure

Project Directories

• templates
• nodes
• lib
• static
• public

Dynamic Content

Node Headers

Substitution Parameters

Tags

RSS, Sitemap, robots.txt

User-Defined Python Code

Soju (custom substitution parameter functions)

Handlers (custom handler functions, dynamically-generated nodes)

Uriel API

Call any part of the Uriel code directly from your own Soju functions and user-defined handlers.

Uriel API

• Node Classes
• Functions
• Constants
• Exceptions

Security

Each Uriel project can contain user-defined Python code, which can be executed every time Uriel builds that project.

The user-defined code is located in the following project files:

• lib/soju.py
• lib/handlers.py

Since projects can execute code during the build phase, make sure you trust the project before building it.

Project Links

Uriel Web Site

Uriel Documentation

Uriel GitHub