Shromp config (shromp.toml)
Shromp's configuration file.
Properties
| Property | Description |
|---|---|
base_url |
Overwrite base URL for assets. Useful when hosting files in any location other than the root. Default: / |
source_folder |
Folder where the source markdown files are located Default: ./docs/ |
output_folder |
Folder where the generated HTML files should be saved Default: ./public/ |
theme_folder |
Folder where site theme handlebars templates are located Default: ./default-theme/ |
asset_pipeline_file |
Path to asset processing file. Optional. Check the reference for more details. |
generate_doc_index |
Can disable doc index generation even when index.md is present Default: false |
enable_versions |
Include version in the URL Default: true |
version_to_publish |
Documentation version (files will be nested in this folder) Default: 1.0.0 |
enable_locales |
When enabled, the first folder level holds the locales roots, and each locale root has independent navigation Default: true |
default_locale |
Default site locale. Used in doc index and when enable locales is disabled Default: en |
anchor_prefix |
Prefix to use on anchors generated by Shromp. By default, an id is generated for every heading so navigation links can point to the correct section of the page. This property defines a prefix to reduce the chance of conflict with user-defined anchors. Default: sp- |