Setup
DocsForge's setup guides help you customize every aspect of your documentation site. All configuration happens in docsforge.yml.
Overview
The following guides cover the most common customization scenarios:
Customize primary, accent, and background colors. Configure light and dark mode palettes.
Use Google Fonts or custom font files for text and code.
Set the site language, configure search stemming, and RTL support.
Tabs, sections, indexes, footer links, and table of contents.
Configure search behavior, separators, and result presentation.
Add Plausible or Google Analytics to track page views.
Configure Open Graph and Twitter Card meta tags for rich link previews.
Enable HTML minification, asset compression, and build optimization.
Link to your source repo with "Edit this page" buttons.
Configuration file
All customization is done in docsforge.yml. DocsForge loads all plugins and Markdown extensions automatically — you only configure what you want to customize.
site_name: My Project
site_url: https://example.com/docs/
site_author: Your Name
site_description: Documentation for My Project
repo_name: username/repo
repo_url: https://github.com/username/repo
copyright: Copyright © 2025 Your Name
theme:
name: material
features:
- navigation.tabs
- navigation.sections
- navigation.top
- search.highlight
- search.suggest
- content.code.copy
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
accent: teal
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: teal
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono
Next steps
Pick a guide above to customize a specific aspect of your site. Each guide includes copy-paste-ready configuration examples.