Chirun config schema v1

Chirun config files are YAML objects.

Download the schema in JSON-Schema format

Chirun package configuration

object

base_dir

Base directory of the output
string
title

Title of the package
string
license
Copyright and licensing information
object
- year
  
  Copyright year
  string
- by
  
  Copyright attribution
  string
- url
  
  URL of the full licence text
  string
- name
  
  Name of the licence
  string
locale

ISO 639 language code for localisation
string
author

Name of the author
string
institution

Author's institution
string
static_dir

Path to the static files source directory
string
code

Course code
string
year

Year
string
root_url

Root URL of the output
string
build_pdf

Build PDF files?
boolean
build_zip

Build a .zip file of the whole package?
boolean
num_pdf_runs

Number of runs for building PDFs
number
format_version

Version number of the config format used
number
mathjax_url

URL to load MathJax from
string
structure

Structure
array

Items:

Structure item
css

Extra CSS files to load in HTML pages.
array

Items:

string
js

Extra JavaScript files to load in HTML pages.
array

Items:

string
themes_dir

Path of the themes directory
string
themes
Themes to use
array
Items:

object

source

Path to the theme
string

title

Title
string

path

Path to the theme's source
string

hidden

Hidden?
boolean

Subschemas

Structure item
Structure item
object
Any of

Option 1

Introduction

type

string
= "introduction"

Option 2

Part

type

string
= "part"

leading_text

Leading text
string

location

Location
string

Must be one of:

"below"

"above"

Option 3

Document

type

string
= "document"

splitlevel

Structure splitting level
number

Option 4

Chapter

type

string
= "chapter"

Option 5

Standalone

type

string
= "standalone"

Option 6

URL

type

string
= "url"

Option 7

HTML file

type

string
= "html"

Option 8

Slides

type

string
= "slides"

title_slide

Include a title slide?
boolean

Option 9

Numbas Exam

type

string
= "exam"

Option 10

Jupyter Notebook

type

string
= "notebook"
- type
  
  Type
  string
  
  Must be one of:
  
  "introduction"
  
  "part"
  
  "document"
  
  "chapter"
  
  "standalone"
  
  "url"
  
  "html"
  
  "extractedsection"
  
  "slides"
  
  "exam"
  
  "notebook"
- title
  
  Title
  string
- slug
  
  URL slug
  string
- author
  
  Name of the author
  string
- source
  
  Path of the item's source file.
  string
- is_hidden
  
  Is this item hidden?
  boolean
- build_pdf
  
  Build a PDF version?
  boolean
- pdf_url
  
  Output path of the PDF file
  string
- html
  
  HTML content
  string
- extractedsection
  
  A section extracted from a document
  string
- thumbnail
  
  Path of thumbnail image
  string
- content
  
  Sub-items
  array
  
  Items:
  
  Structure item
- sidebar
  
  Show the sidebar?
  boolean
- topbar
  
  Show the top navigation bar?
  boolean
- footer
  
  Show the page footer?
  boolean
- css
  
  Extra CSS files to load in this item's HTML pages..
  array
  
  Items:
  
  string
- js
  
  Extra JavaScript files to load in this item's HTML pages.
  array
  
  Items:
  
  string
- hash_salt
  
  Salt used to hash the URLS of hidden items.
  string