设置

DocsForge 的设置指南帮助你自定义文档站点的每个方面。所有配置都在 docsforge.yml 中完成。

概述

以下指南涵盖最常见的自定义场景：

更改颜色

自定义主色、强调色和背景色。配置浅色和深色模式调色板。
更改字体

使用 Google Fonts 或自定义字体文件作为正文字体和代码字体。
更改语言

设置站点语言、配置搜索词干提取和 RTL 支持。
设置导航

标签页、章节、索引、页脚链接和目录。
设置站点搜索

配置搜索行为、分隔符和结果展示。
设置站点分析

添加 Plausible 或 Google Analytics 以跟踪页面浏览量。
设置社交卡片

配置 Open Graph 和 Twitter Card 元标签，实现丰富的链接预览。
构建优化站点

启用 HTML 压缩、资源压缩和构建优化。
添加 Git 仓库

链接到源代码仓库，并显示“编辑此页”按钮。

配置文件

所有自定义都在 docsforge.yml 中完成。DocsForge 会自动加载所有插件和 Markdown 扩展——你只需配置想要自定义的部分。

docsforge.yml

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 &copy; 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

下一步

从上方选择一个指南，自定义站点的特定方面。每个指南都包含可直接复制粘贴的配置示例。