Sign Up

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.

fielddescriptionrequireddefault
accentMain accent color of your color theme. For example, your brand color.true
grayscaleGray color scale of your color theme. One of gray, mauve, slate, sage, olive and sandfalsegray

Logo

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

fielddescriptionrequired?default
srcPath to image within _assets directorytrue
src_darkPath to image to use in dark modefalse

Favicon

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

fielddescriptionrequired?default
srcPath to image within _assets directorytrue

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 toggled

  • dark: your site will use the dark theme and it can't be toggled

  • auto: your site will use system theme and it can be toggled

OpenApi

The open_api property is a list of Source definitions.

Source

fielddescriptionrequired?default
spec_filePath to OpenAPI specification filetrue
uri_prefixPath to the generated OpenAPI pages in your docsfalse

User Preferences

The user_preferences property is a map of preference definitions.

Preference

fielddescriptionrequired?default
labelLabel for selectortrue
defaultDefault valuetrue
valuesPossible values as strings or User Preference Option objectstrue

User Preference Option

fielddescriptionrequired?default
labelLabel for User Preference Optiontrue
valueKey for User Preference Optiontrue

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.

fielddescriptionrequired?default
linksAn array of external links that will be placed on the header at the top of your site.false
ctaCall-to-action button that will be placed on the header at the top of your site.false

Header Link

fielddescriptionrequired?default
labelLabel that will be displayed in your header link.true
externalAn external url where the user will navigate upon clicking the linktrue

Header Call-To-Action

fielddescriptionrequired?default
labelLabel that will be displayed in your call-to-action button.true
externalAn external url where the user will navigate upon clicking the buttontrue

Redirects

The redirects property is a list of Redirect objects.

Redirect

The redirect object contains the source and destination urls of a single redirect.

fielddescriptionrequired?default
fromA url path from where the redirect will be activated.true
toA url path to where the redirect will lead to.true

Was this page helpful?