Reference Documentation

This is the definite reference for all things webgen! You will find in-depth information about everything, from file formats, configuration options, meta information keys to extension documentation:

  • Webgen Page Format: Information about/Specification of the file format used by all custom webgen file types, for example, by page and template files.

  • Extensions: Detailed information on every built-in extension, be it content processors, path handlers, tags, …

  • Configuration options: Detailed information on all configuration options.

  • Meta information keys: Descriptions and usage patterns for every node meta information key that is used in one way or another by webgen or the built-in extensions.

  • YAML: This is the markup language used for webgen’s configuration file and every other place where structured but easily human readable/writable information is needed.

  • Glossary: Contains definitions of terms that are used throughout the documentation and are special to webgen.

  • API: The Application Programming Interface (API) for webgen. Contains useful information if you want to write extensions.