Project Configuration Reference
This document explains the available configuration options in the doctave.yaml
file.
Configuration Example
An example doctave.yaml
demonstrating the available configuration options.
---
title: Doctave Docs
theme:
logo:
src: _assets/doctave-logo.svg
src_dark: _assets/doctave-logo-dark.svg
colors:
main: "#7B8FFE"
color_mode: auto
favicon:
src: _assets/favicon.ico
open_api:
- spec_file: http-spec.json
uri_prefix: /api
user_preferences:
tier:
label: Tier
default: Starter
values:
- Starter
- Growth
- Enterprise
header:
cta:
external: https://dashboard.doctave.com/users/register
label: Sign Up
links:
- external: https://doctave.com
label: What's Doctave?
styles:
- _assets/style.css
redirects:
- from: /docs/old/path
to: /docs/new/path
tabs:
- label: Home
path: /
icon:
set: lucide
name: home
- label: Desktop
path: /desktop
subtabs:
- label: Introduction
path: /desktop/introduction
- label: Advanced
path: /desktop/advanced
- label: Dashboard
path: /dashboard
subtabs:
- label: Introduction
path: /dashboard/introduction
- label: Advanced
path: /dashboard/advanced
- label: Changelog
external: http://example.com
Reference
Below are explanations of all the objects and their fields in the project configuration.
Your doctave.yaml
should contain a list of these objects.
Title
The title
property is a string which defines the project title.
Theme
Colors
The colors
property is a map that specifies colors for the project. Doctave will generate a palette from your chosen accent color and grayscale.
field | description | required | default |
---|---|---|---|
accent | Main accent color of your color theme. For example, your brand color. | true | |
grayscale | Gray color scale of your color theme. One of gray , mauve , slate , sage , olive and sand | false | gray |
Logo
The logo
property is a map that specifies the logo for the project.
field | description | required? | default |
---|---|---|---|
src | Path to image within _assets directory | true | |
src_dark | Path to image to use in dark mode | false |
Favicon
The favicon
property is a map that specifies the favicon for the project.
field | description | required? | default |
---|---|---|---|
src | Path to image within _assets directory | true |
Color Mode
The color_mode
property is used to control which color schemes are available for your site. By default it's set to auto
.
When color mode is
light
: your site will use the light theme and it can't be toggleddark
: your site will use the dark theme and it can't be toggledauto
: your site will use system theme and it can be toggled
OpenApi
The open_api
property is a list of Source definitions.
Source
field | description | required? | default |
---|---|---|---|
spec_file | Path to OpenAPI specification file | true | |
uri_prefix | Path to the generated OpenAPI pages in your docs | false |
User Preferences
The user_preferences
property is a map of preference definitions.
Preference
field | description | required? | default |
---|---|---|---|
label | Label for selector | true | |
default | Default value | true | |
values | Possible values as strings or User Preference Option objects | true |
User Preference Option
field | description | required? | default |
---|---|---|---|
label | Label for User Preference Option | true | |
value | Key for User Preference Option | true |
Styles
The styles
property is a list of paths to stylesheets in the _assets
directory.
Header
Header contains settings for your header bar at the top of your site.
field | description | required? | default |
---|---|---|---|
links | An array of external links that will be placed on the header at the top of your site. | false | |
cta | Call-to-action button that will be placed on the header at the top of your site. | false |
Header Link
field | description | required? | default |
---|---|---|---|
label | Label that will be displayed in your header link. | true | |
external | An external url where the user will navigate upon clicking the link | true |
Header Call-To-Action
field | description | required? | default |
---|---|---|---|
label | Label that will be displayed in your call-to-action button. | true | |
external | An external url where the user will navigate upon clicking the button | true |
Redirects
The redirects
property is a list of Redirect objects.
Redirect
The redirect object contains the source and destination urls of a single redirect.
field | description | required? | default |
---|---|---|---|
from | A url path from where the redirect will be activated. | true | |
to | A url path to where the redirect will lead to. | true |