Qgoda

Qgoda static site generator configuration file format

Type object
File match _qgoda.yaml _qgoda.yml _qgoda.json _localqgoda.yaml _localqgoda.yml _localqgoda.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/qgoda/latest.json
Source https://www.qgoda.net/schemas/qgoda.json

Validate with Lintel

npx @lintel/lintel check
Type: object

A Qgoda Configuration

Properties

analyzers string[]

Additional analyzers to run after the Qgoda standard analyzer.

Default:
[]
build-task-timeout number

Number of seconds to wait before forcibly terminating pre-build or post-build tasks; defaults to 300 seconds.

Default: 300
min=1
case-sensitive boolean

Set to true if a case-sensitive file system shoud be assumed.

Default: false
compare-output boolean

Should existing output files be read and compared to the new version to avoid updating timestamps (default => true)

Default: true
defaults object[]

Default values, see http://www.qgoda.net/en/docs/defaults

Default:
[]
exclude string[]

List of additional file name patterns that should be ignored for building the site.

Default:
[]
exclude-watch string[]

List of additional file name patterns that should be ignored when changed in watch mode.

Default:
[]
front-matter-placeholder object

An object of valid chain names or '*' that give the frontmatter placeholder string for each configured processor chain.

Default:
{
  "*": "[% '' %]\n"
}
generator string

Value for the generator meta tag in generated pages.

Default: "Qgoda vv0.11.0 (https://www.qgoda.net/)"
helpers object

Key-value pairs of command identifiers and the command to run in parallel, when running in watch mode. Default: empty.

Default:
{}
index string

Basename of a file that is considered to be the index document of a directory.

Default: "index"
latency number

Number of seconds to wait until a rebuild is triggered after a file system change in watch mode.

Default: 0.5
min=0
linguas string[]

List of language identifiers complying to RFC4647 section 2.1 but without any asterisk (*) characters.

location string

Template string for the output location.

Default: "/{directory}/{basename}/{index}{suffix}"
no-scm string[]

List of additional file name patterns that should be processed in scm mode, even when not under version control

Default:
[]
paths object

Configurable paths.

Default:
{}
5 nested properties
plugins string required

Directory for plug-ins.

Default: "_plugins"
po string required

Directory for po files and other i18n related files.

Default: "_po"
site string required

Directory where to store rendered files, defaults to the absolute path to '_site' in the current directory.

Default: "_site"
timestamp string required

Name of the timestamp file containing the seconds since the epoch since the last write of the site.

Default: "_timestamp"
views string required

Directory where view templates are searched.

Default: "_views"
po object

Variables for internationalization (i18n) and the translation workflow.

Default:
{}
11 nested properties
copyright-holder string

Copyright information for the original content.

Default: "Set config.po.copyright-holder in '_config.yaml'."
mdextra string[]

List of file name patterns for additional markdown files to translate.

Default:
[]
msgfmt string[]

The 'msgfmt' command or an array of the program name plus arguments.

Default:
[
  "msgfmt"
]
msgid-bugs-address string

Where to report translation problems with the original strings.

Default: "Set config.po.msgid-bugs-address in '_config.yaml'."
msgmerge string[]

The 'msgmerge' command(or an array of the program name plus arguments.

Default:
[
  "msgmerge"
]
qgoda string[]

The 'qgoda' command or an array of the program name plus arguments.

Default:
[
  "qgoda"
]
reload boolean

Whether to throw away the translation before every rebuild, defaults to false.

Default: false
textdomain string

An identifier for the translation catalog (textdomain), defaults to 'messages'.

Default: "messages"
tt2 string[]

A list of file name patterns or one single pattern, where translatable templates for the Template Toolkit version 2 are stored, defaults to '_views'.

Default:
[]
xgettext string[]

The 'xgettext' command or an array of the program name plus arguments.

Default:
[
  "xgettext"
]
xgettext-tt2 string[]

The 'xgettext-tt2' command or an array of the program name plus arguments.

Default:
[
  "xgettext-tt2"
]
post-build
post-processors object

Modules to run after each build.

Default:
{
  "modules": [],
  "options": {}
}
2 nested properties
modules string[] required

The post-processor modules.

Default:
[]
options object required

Additional options for the post-processor plug-ins

Default:
{}
pre-build
precious string[]

List of file name patterns that should notbe deleted in the output directory.

Default:
[]
private

Site-specific variables. You can also choose the namespace 'site' if you prefer.

processors object

The processors to use for generating content.

Default:
{}
3 nested properties
chains object required

The processor chains.

Default:
{
  "html": {
    "modules": [
      "TT2",
      "Strip",
      "HTMLFilter"
    ]
  },
  "markdown": {
    "modules": [
      "TT2",
      "Strip",
      "Markdown"
    ],
    "suffix": "html",
    "wrapper": "html"
  },
  "raw": {
    "modules": [
      "TT2",
      "Strip"
    ]
  },
  "xml": {
    "modules": [
      "TT2",
      "Strip"
    ]
  }
}
options object required

Additional options for the processor plug-ins

Default:
{
  "HTMLFilter": {
    "AnchorTarget": {},
    "CleanUp": {},
    "Generator": {},
    "TOC": {
      "content-tag": "qgoda-content",
      "end": 6,
      "start": 2,
      "template": "components/toc.html",
      "toc-tag": "qgoda-toc"
    }
  }
}
triggers object required

Filename extenders that trigger a particular chain if not specified in front matter or defaults.

Default:
{
  "htm": "html",
  "html": "html",
  "json": "raw",
  "md": "markdown",
  "mdown": "markdown",
  "mdwn": "markdown",
  "mkd": "markdown",
  "mkdn": "markdown",
  "xml": "raw"
}
scm string

Source code management (SCM) that is in use. If present, only files that are under version control and those matching 'no-scm' are processed. Currently only git is supported.

Constant: "git"
site

Site-specific variables. You can also choose the namespace 'private' if you prefer.

srcdir string

The source directory for all assets. Do not set that variable yourself! It will be overwritten at runtime with the absolute path to the current directory.

Default: "."
taxonomies object

Key/value pairs of taxonomy names and their respective weights for the computation of relatedness.

Default:
{
  "categories": 3,
  "links": 1,
  "tags": 2
}
title string

The title of the site. It has no particular semantics.

Default: "A new Qgoda Powered Site"
track-dependencies boolean

Set to true if you want to speed up watch mode by re-processing only assets that have changed or depend on changed files.

Default: false
url string

The main url of the site.

Default: "Configure 'url' in _config.yaml!"
view string

The default view template to use.

Default: "default.html"
minLength=1

Definitions

buildTasks object[]