Manifest Format - tour.toml

The tour.toml file is used by codetour to configure your project. Since codetour favors convention over configuration, you should rarely have to add to this file once you've setup your project.

This file is written in the TOML format. You should familiarize yourself with that if you aren't familiar with its syntax.

The following is a complete listing of all of codetour's options. Every option is optional unless it is specified otherwise. For optional options, the listed value is its default value.

[tour]
# Required. The title of the tour. Used in the titlebar at the top of the page.
title = "Your great project"
# The description of your project. Used in a <meta> tag.
# Use this space to describe what makes your project great!
description = ""
# A list of authors of this project.
# Example: ["Your Name <[email protected]>", "Other Name <[email protected]>"]
authors = []

[build]
# The path to the SUMMARY.md file used to build the table of contents
summary_path = "SUMMARY.md"
# The path where the built website will be placed
build_dir = "_site"
# The path relative to the build directory where static files
# (js, css, etc.) will be placed
static_dir = "static"
# Extra paths to copy into the build directory
# Unstable. See: https://github.com/sunjay/codetour/issues/23
include = []

[js]
# Filename of the codetour JavaScript file to be generated in the static directory
filename = "codetour.js"

[css]
# Filename of the codetour CSS file to be generated in the static directory
filename = "codetour.css"
# Output style for the generated CSS
# Either "compressed" or "expanded"
output_style = "compressed"