There are several package-level settings, giving metadata about the package, its contents, and some options controlling the build process.
- Title (
The title of the package.
- Author (
The name(s) of the package’s author(s).
- Institution (
The owning institution of the content, e.g. “University of Somewhere”.
- Course code (
A code for the course or module that this material belongs to, e.g. “MAS0001”.
- Year (
The year or date that the material is delivered.
- Language (
The ISO 639-1 code for the primary language that the material is presented in. Once Chirun has been translated to other languages, this will determine the language used for text in the interface.
- Content (
A list of content items forming the content of the package.
- Base directory (
The base directory of the output. It only makes sense to change this if you’re running the chirun command-line tool on your own computer.
- Static files directory (
The path to your package’s static files, which will be copied into the output unchanged.
- Root URL (
The root URL of the output.
base_dir, followed by
theme, if they’re set.
- Build PDFs? (
Should PDF files be created? Turn off if you are happy just to provide HTML output.
- Number of PDF runs (
The number of times to run
pdflatexon LaTeX documents. Documents with complicated reference structures might need more than one run.
- Format version (
The version number of the config format used.
- URL to load MathJax from (
The URL to load MathJax from. This should be MathJax v3.
- Themes (
An array of themes to use. At the moment there’s only one theme; see the config schema for the structure of this property if you’re developing a new theme.
Default value: Just the default theme.