rest2web: Building Websites Across the Known Universe

- rest2web

# rest2web - The Site Builder

## Autogenerating Websites with Docutils

Author: | Michael Foord
Contact: | fuzzyman@voidspace.org.uk
Version: | 0.5.1
Date: | 2006/12/16
License: | BSD-License
Home Page: | rest2web
Quick Download: | rest2web-0.5.1.zip
Tarball: | rest2web-0.5.1.tar.gz
Sourceforge: | rest2web Project Page
Development: | SVN Repository
Support: | rest2web Mailing List

# rest2web - The Website Builder

Maintaining websites or project documentation in HTML is a pain. rest2web takes out the pain, and brings back the joy.

rest2web is a simple tool that lets you build your website from a single template (or as many as you want), and keep the contents in ReStructured Text [1]. (You can still keep pages in HTML if needed.)

It can also aid in having multiple translations of your site (i18n) and a host of other features.

Below is an index to all the rest2web documentation, but for more information check out the introduction.

Alternatively, browse the following websites. They are all built with rest2web and show the range of different styles it is capable of creating [2] :

- Voidspace
- Project Pipe
- Martin Krafft's PHD Pages
- HP Linux Imaging and Printing
- Live Off Grid
- CRSR
- Civitas
- German Website on Text Based Tools
- The Python Academy (English)
- The Python Academy (Deutsch)
- Creatext
- Tibet.net
- Homesite of Marius Soutier
- Homesite of Paul Bartletts
- Homesite of Peter Brett
- Homepage of Gaël Varoquaux
- The Rhyming Panda
- Aikido Club Website
- Introduction to Scott Mcdermott

It also builds the documentation for the following projects :

- rest2web
- PyGeo
- Movable Python
- Firedrop2

To see recent changes, visit the Changelog.

### Pages

- Introduction to rest2web

  A gentle introduction to rest2web.

- Quickstart

  An quick start guide showing how to use rest2web to create a simple website.

- Configuring

  The rest2web config file.

- Tutorial

  An tutorial showing how to use rest2web to create a simple website.

- Command Line Options

  The different command line options for rest2web. This includes passing uservalues for use in your pages and templates.

- Building Websites the Easy Way

  A special mode (set from the command line) allows rest2web to build a website from a collection of ReST documents. In this mode templates, index pages and restindexes are optional.

- Templates

  A description of templating, and the special values available in the namespace.

- The restindex

  An explanation of the options and default values in the restindex.

- The Standard Functions

  The standard functions for printing indexes, navigation trails, and sidebars.

- Macros in rest2web

  The text macro system used by rest2web. Includes documentation on all the example macros.

- Special Files

  A list of all the special filenames that rest2web uses - and what they are for.

### Sub Sections

- Reference Section

  Documentation and reference for rest2web.

- Test and Example Site

  This website tests all the features of rest2web. If it builds correctly then all is well. It also serves as an illustration of rest2web, including some of the more obscure options and capabilities.

- Translation Example

  A very basic example of a website with multiple translations.

- Example Gallery

  Example gallery from the gallery plugin. (Only present if you build it).

[1] | ReST is a plain text WYSIWYG markup. It's a great way of keeping documents in a readable and editable form.

[2] | If your site is built with rest2web, then Contact Me to get it added to this list.

Return to Top
Part of the rest2web Docs
Page last modified Tue Dec 19 17:15:50 2006.

- Index Page
- Pages
- Introduction
- Quickstart
- Config File
- Tutorial
- Command Line
- Force Mode
- Templates
- restindex
- Functions
- Macros
- Special Files
- Sub Sections
- Reference
- Test Site
- Translation
- Gallery