Configuration

This document goes through all the different configuration options available.

Doctave.yaml

First, let's look at the options available in the doctave.yaml file.

NOTE! Any changes you make to this file will only come into effect when you restart the preview server, or rebuild your site.

title

This sets the name of your project. It serves two purposes:

  • It will displayed as the title at the top right of the page
  • The HTML page title will be set to this when you're on the root page

This is a required setting.

Example:

---
title: Authentication service

port

Sets the port the development server will listen on when running the serve command.

This is an optional setting.

This setting must be a positive integer.

Example:

---
port: 5432

colors.main

This sets the main color for your site. You can read more about this in customization. Currently this is the only color you can customize.

This is an optional setting.

This setting must be a valid hex value.

Example:

---
colors:
  main: #FF78E4

logo

The name of the file to serve as your logo. You can read more about this in customization.

This is an optional setting.

---
logo: logo.png

Customizes your site navigation on the left side of the page.

You can read more about this under custom navigation.

This is an optional setting.

navigation:
  - path: docs/installing.md
  - path: docs/tutorial.md
  - path: docs/features
    children: "*"

All commands

All commands support the following option.

--no-color

Disable terminal colors.

This is an optional argument.

Example:

$ doctave serve --no-color

Serve command

Currently the serve command takes only one optional argument.

--port, -p

Sets the port the development server will listen on when running the serve command.

This is an optional argument.

Example:

$ doctave serve --port 5432

Build command

Currently the build command takes only one optional argument.

--release

This flag will build the site without development dependencies. Currently this means stripping out livereload.js from the bundle, but can be extended in the future to include other actions.

This is an optional argument.

Example:

$ doctave build --release

Powered by Doctave