The build command will generate a static website from the files in your project.

ct build

This command will try to parse the Manifest File (tour.toml). Using that, it will load the Table of Contents (SUMMARY.md) and start to generate each page of your project.

By default, the generated website is stored in a new _site folder. The folder starts with an underscore (_) to avoid conflicting with any other folders you may be using for your project.

Stability Note:

Currently, the generated website does not maintain the same directory structure as its source files. That is, each page listed in SUMMARY.md is generated into an HTML file at the root of the generated project even if it resides in a subdirectory of the project.

Downloadable Attachments related to a particular page are put into a subdirectory specific to that page to avoid any conflicts, but the pages themselves are all put flatly into the root directory of the generated project.

This may change one day since codetour is still a relatively young project. That being said, you can avoid having your project break too much by following the conventions in the Project Structure section and avoiding nesting steps in directories.

Codetour is still developing, so contributions and discussion around how the generated website should be structured are welcome!

The --manifest-path option allows you to specify a full path to the configuration file you want codetour to use. This file does not need to be named tour.toml.

The path provided with this option should not be the directory of the configuration file you want codetour to use. It should be the full path to the file itself.

The command will still be run as if it was invoked in the directory of the provided configuration file. This option is just in case you are either not in the directory of your project or if you need to name the configuration file something other than tour.toml.