Site Configuration
The site configuration is located in the “site.json” file in the root directory of a basalt site. It is used to configure properties relating to the site itself, the title, base url, theme, and other such options.
Appearance Options
| Property | Type | Required | Description |
|---|---|---|---|
| title | String | Yes | Title of your website |
| theme | String | Yes | Name of the theme to use |
| subtitle | String | No | Subtitle of your website |
Generation Options
| Property | Type | Required | Description |
|---|---|---|---|
| base_url | String | No | Base URL used for generation of links. Defaults to “/”. |
| custom_homepage | Boolean | No | If set to true, basalt will render the page with the filename “home.md” instead of using the post list as the homepage. |
| max_preview_length | Number | No | How many characters after which to cut off the preview of a post in post lists. Defaults to 50. |
| feed_preview_length | Number | No | Same as max_preview_length, but for the Atom feed. Defaults to unlimited. |
| static_in_root | Boolean | No | For advanced users. Instead of in /static, files in the static directory will be placed in the root of the built site. |
| permalink_format_simple | Boolean | No | Use older, simpler format for links to posts (/post/<slug>). |
| use_atom_feed | Boolean | No | Enable/disable atom feed generation. Defaults to false. |
| upload_target | String | No | Specifies where the upload command uploads to. |
Custom Menu
| Property | Type | Required | Description |
|---|---|---|---|
| use_custom_menu | Boolean | No | Overrides automatic menu generation with that specified in custom_menu |
| custom_menu | Array | If use_custom_menu is enabled | Holds the menu items for custom menu generation as specified in Custom Menu |
Custom Post Types
| Property | Type | Required | Description |
|---|---|---|---|
| custom_post_types | Array | No | If specified, adds specified post types. See Custom Post Types for more information. |