Overview of Orbiter
All requests are forwarded to
index.phpwhich loads all plugins from the
pluginsfolder and parses
config.inifor things like document location and template files.
Orbiter parses request URI such as
http://example.com/aboutand tries to find a coresponding source document in the document folder.
Orbiter reads the source document and passes it through a markup converter (such as Markdown, Latex or none).
Parsed document is sent to the templating engine (Mustache, Smarty, plain PHP, etc.) which returns HTML that is sent to the visitor.
Using Front Matter
Front matter is a simple concept of adding information to your documents that you don't want to be included in the rendered content.
Take a look at this sample document:
slug = about time = August 12, 2012 # About Orbiter Orbiter is a simple and extendable PHP tool for publishing beautiful websites out of Markdown documents…
Front matter is everything at the top of the document seperated with a blank line from the rest of the document:
slug = about time = August 12, 2012
Key values pairs are usually separated by either
=. While several static site generators support Yaml syntax for the front matter, Orbiter chooses to use standard INI syntax by default (because it doesn't require any external libraries and is supported by PHP out of the box).
The default front matter support is added by the meta plugin which can be removed or replaced to use Yaml syntax instead.