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
logo:
  src: _assets/doctave-logo.svg
  src_dark: _assets/doctave-logo-dark.svg
colors:
  main: "#7B8FFE"
open_api:
  - spec_file: http-spec.json
    uri_prefix: /api
user_preferences:
  tier:
    label: Tier
    default: Starter
    values:
      - Starter
      - Growth
      - Enterprise
styles:
  - _assets/style.css

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.

Logo

The logo property is a map that specifies the logo for the project.

field description required? default
spec_file Path to image within _assets directory true
src_dark Path to image to use in dark mode false

OpenApi

The open_api property is a list of Source definitions.

Source

field description required? default
src Path to image within _assets directory true
src_dark Path to image to use in dark mode false

Colors

field description required default
main Main highlight color false #7B8FFE
main_dark Main highlight color in dark mode false #7B8FFE
content_bg Background of main content area (where this table is) false #FFFFFF
content_bg_secondary Secondary background color in content area (e.g. code samples) false #F1F5F9
content_bg_dark Background of main content area in dark mode false #0F172A
content_bg_secondary_dark Secondary background of main content in dark mode false #1E293B
nav_bg Background of left side navigation false #F8FAFC
nav_bg_dark Background of left side navigation in dark mode false #0F172A
header_bg Header background color false #FFFFFF
header_bg_secondary Secondary header background color false #F1F5F9
header_bg_dark Header background color in dark mode false #0F172A
header_bg_secondary_dark Secondary header background color in dark mode false #1E293B

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 an list of paths to stylesheets in the _assets directory.

Was this page helpful?