# Docs

- Hugo: Solitude for Hugo
  - Getting Started
    - [Introduction](/docs/hugo/getting-started/introduction): Understand the native Hugo edition of Solitude and how its documentation is organized.
    - [Installation](/docs/hugo/getting-started/installation): Install Solitude as a Hugo theme and enable its required output formats.
    - [First Run](/docs/hugo/getting-started/first-run): Create the first post, preview the site, and make a production build.
  - Configuration
    - [Site Basics](/docs/hugo/configuration/site): Configure site identity, languages, pagination, taxonomies, and required outputs.
    - [Appearance](/docs/hugo/configuration/appearance): Control theme colors, display mode, fonts, loading, highlighting, and lightboxes.
    - [Home Page](/docs/hugo/configuration/home): Configure the home banner, recommendation groups, and post list.
    - [Navigation](/docs/hugo/configuration/navigation): Build Hugo menus and configure Solitude navigation actions.
    - [Sidebar](/docs/hugo/configuration/sidebar): Arrange sidebar modules for home, post, and feature pages.
    - [Posts](/docs/hugo/configuration/posts): Configure post metadata, covers, copyright, sharing, related content, and expiry notices.
    - [SEO and Outputs](/docs/hugo/configuration/seo): Configure canonical site URLs, metadata, feeds, sitemap, robots, and verification.
    - [Advanced Configuration](/docs/hugo/configuration/advanced): Configure optional modules, custom assets, keyboard actions, and CDN dependencies.
    - [Browser API](/docs/hugo/configuration/browser-api): Use the stable Solitude browser API across PJAX navigation.
  - Content Writing
    - [Front Matter](/docs/hugo/content-writing/front-matter): Use Hugo Front Matter to control posts, pages, taxonomies, aliases, and Solitude presentation.
    - [Shortcodes](/docs/hugo/content-writing/shortcodes): Use the native Hugo shortcodes bundled with Solitude.
  - Feature Pages
    - [About Page](/docs/hugo/features/about): Build the modular About page from a Hugo data file.
    - [Links Page](/docs/hugo/features/links): Maintain grouped links and asynchronous output with data/links.yaml.
    - [Equipment Page](/docs/hugo/features/equipment): Publish an equipment or toolkit page from grouped YAML data.
    - [Music Page](/docs/hugo/features/music): Create the full music page and configure Meting playback.
    - [Message Page](/docs/hugo/features/message): Create a dedicated message page backed by the active comment provider.
    - [Brevity Page](/docs/hugo/features/brevity): Publish short updates from data/brevity.yaml.
    - [Recent Comments](/docs/hugo/features/recent-comments): Aggregate recent comments into a dedicated page and sidebar modules.
    - [Gallery](/docs/hugo/features/gallery): Compose responsive galleries with Solitude Hugo shortcodes.
  - Integrations
    - Search
      - [Local Search](/docs/hugo/integrations/search/local-search): Generate and use the built-in Hugo search index.
      - [Algolia](/docs/hugo/integrations/search/algolia): Connect Solitude search to an Algolia index.
      - [DocSearch](/docs/hugo/integrations/search/docsearch): Configure the Algolia DocSearch interface.
    - Comments
      - [Twikoo](/docs/hugo/integrations/comments/twikoo): Connect Twikoo to Solitude posts and feature pages.
      - [Waline](/docs/hugo/integrations/comments/waline): Connect a Waline server and optional page-view integration.
      - [Valine](/docs/hugo/integrations/comments/valine): Configure Valine comments, visitors, and recent-comment data.
      - [Artalk](/docs/hugo/integrations/comments/artalk): Connect an Artalk server and site identifier.
      - [Giscus](/docs/hugo/integrations/comments/giscus): Use GitHub Discussions as the Solitude comment backend.
  - Migration
    - [Migrate from Hexo](/docs/hugo/migration/from-hexo): Move a Solitude Hexo site to the native Hugo edition without carrying obsolete contracts.
  - FAQ
    - [Common Questions](/docs/hugo/faq/common): Answers about requirements, configuration ownership, updates, and deployment.
    - [Troubleshooting](/docs/hugo/faq/troubleshooting): Diagnose build failures, missing assets, search output, and repeated runtime behavior.
- Hexo: Solitude for Hexo
  - Getting Started
    - [Introduction](/docs/hexo/getting-started/introduction): Understand Solitude 4, its requirements, and its configuration model.
    - [Installation](/docs/hexo/getting-started/installation): Install Solitude 4 and prepare a root theme configuration.
    - [First Run](/docs/hexo/getting-started/first-run): Generate a Solitude 4 site and verify its modules load correctly.
    - [Upgrade to 4.0](/docs/hexo/getting-started/upgrade-v4): Migrate a Solitude 3.x blog to Solitude 4.0's native ES-module runtime.
  - Configuration
    - [Site Configuration](/docs/hexo/configuration/site): Configure Hexo identity and the Solitude site mark.
    - [Navigation](/docs/hexo/configuration/navigation): Configure menus, groups, right-side actions, and the context menu.
    - [Homepage](/docs/hexo/configuration/home): Configure the top banner, recommendations, groups, and post list.
    - [Sidebar](/docs/hexo/configuration/sidebar): Configure sidebar composition, author details, TOC, tags, and site statistics.
    - [Posts](/docs/hexo/configuration/posts): Configure post defaults, metadata, sharing, expiration, and related posts.
    - [SEO](/docs/hexo/configuration/seo): Configure canonical Hexo metadata, Open Graph, verification, robots, and sitemaps.
    - [Appearance](/docs/hexo/configuration/appearance): Configure v4 colors, display mode, fonts, loading, highlighting, and images.
    - [Advanced Configuration](/docs/hexo/configuration/advanced): Configure optional rendering, PWA, injection, UI, ads, and CDN features.
    - [Browser API](/docs/hexo/configuration/browser-api): Extend Solitude 4 with its public browser API and PJAX lifecycle.
  - Content Writing
    - [Front Matter](/docs/hexo/content-writing/front-matter): Control Solitude posts and pages with verified Hexo and theme fields.
    - [Tags Plugin](/docs/hexo/content-writing/tags-plugin): Install and use syntax verified by the Solitude tags plugin.
  - Features
    - [Music Page](/docs/hexo/features/music): Create the built-in Meting-based music page.
    - [Brevity](/docs/hexo/features/brevity): Create the built-in short-post timeline and its data source.
    - [About Page](/docs/hexo/features/about): Build the built-in About page from source/_data/about.yml.
    - [Friend Links](/docs/hexo/features/links): Configure friend-link data and v4 asynchronous rendering.
    - [Equipment](/docs/hexo/features/equipment): Create the built-in equipment page and its grouped data.
    - [Message Board](/docs/hexo/features/message): Create the built-in message page with a comment provider and barrage.
    - [Recent Comments](/docs/hexo/features/recent-comments): Create the built-in recent-comment page from an active provider.
    - [Bangumi (Third Party)](/docs/hexo/features/bangumi): Add an anime list with the third-party hexo-bilibili-bangumi plugin.
    - [Gallery (Third Party)](/docs/hexo/features/gallery): Embed masonry galleries with the third-party hexo-gallery tag plugin.
  - Integrations
    - Search
      - [Local Search](/docs/hexo/integrations/search/local-search): Generate a local XML index and enable the Solitude 4 search module.
      - [Algolia Search](/docs/hexo/integrations/search/algolia): Connect the Solitude 4 search UI to a Hexo Algolia index.
      - [DocSearch](/docs/hexo/integrations/search/docsearch): Configure an existing Algolia DocSearch index in Solitude 4.
    - Comments
      - [Twikoo Comments](/docs/hexo/integrations/comments/twikoo): Configure Twikoo as a top-level Solitude 4 comment provider.
      - [Waline Comments](/docs/hexo/integrations/comments/waline): Configure Waline as a top-level Solitude 4 comment provider.
      - [Valine Comments](/docs/hexo/integrations/comments/valine): Configure Valine as a top-level Solitude 4 comment provider.
      - [Artalk Comments](/docs/hexo/integrations/comments/artalk): Configure Artalk as a top-level Solitude 4 comment provider.
      - [Giscus Comments](/docs/hexo/integrations/comments/giscus): Configure Giscus as a top-level Solitude 4 comment provider.
  - FAQ
    - [Common Questions](/docs/hexo/faq/common): Answers to common Solitude 4 installation, configuration, and upgrade questions.
    - [Troubleshooting](/docs/hexo/faq/troubleshooting): Diagnose Solitude 4 builds, ES modules, PJAX, data files, search, and comments.

# 文档

- Hugo: Solitude Hugo 版
  - 快速开始
    - [介绍](/cn/docs/hugo/getting-started/introduction): 了解 Solitude 的 Hugo 原生版本及其文档结构。
    - [安装](/cn/docs/hugo/getting-started/installation): 将 Solitude 安装为 Hugo 主题，并启用主题需要的输出格式。
    - [首次运行](/cn/docs/hugo/getting-started/first-run): 创建第一篇文章、本地预览并完成生产构建。
  - 主题配置
    - [站点基础](/cn/docs/hugo/configuration/site): 配置站点身份、语言、分页、Taxonomies 与必需输出。
    - [外观](/cn/docs/hugo/configuration/appearance): 控制主题色、显示模式、字体、加载、高亮和灯箱。
    - [首页](/cn/docs/hugo/configuration/home): 配置首页横幅、推荐分组和文章列表。
    - [导航](/cn/docs/hugo/configuration/navigation): 使用 Hugo Menus 构建菜单，并配置 Solitude 导航操作。
    - [侧栏](/cn/docs/hugo/configuration/sidebar): 为首页、文章和特色页面安排侧栏模块。
    - [文章](/cn/docs/hugo/configuration/posts): 配置文章元数据、封面、版权、分享、相关文章和过期提示。
    - [SEO 与输出](/cn/docs/hugo/configuration/seo): 配置规范站点 URL、元数据、Feed、Sitemap、robots 和站点验证。
    - [高级配置](/cn/docs/hugo/configuration/advanced): 配置可选模块、自定义资源、键盘操作和 CDN 依赖。
    - [浏览器 API](/cn/docs/hugo/configuration/browser-api): 在 PJAX 导航中使用稳定的 Solitude 浏览器 API。
  - 内容写作
    - [Front Matter](/cn/docs/hugo/content-writing/front-matter): 使用 Hugo Front Matter 控制文章、页面、Taxonomies、别名和 Solitude 展示。
    - [Shortcodes](/cn/docs/hugo/content-writing/shortcodes): 使用 Solitude 随附的 Hugo 原生 Shortcodes。
  - 特色页面
    - [关于页](/cn/docs/hugo/features/about): 使用 Hugo 数据文件构建模块化关于页。
    - [友情链接](/cn/docs/hugo/features/links): 使用 data/links.yaml 维护分组友链与异步输出。
    - [装备页](/cn/docs/hugo/features/equipment): 使用分组 YAML 数据发布装备或工具页。
    - [音乐页](/cn/docs/hugo/features/music): 创建完整音乐页并配置 Meting 播放。
    - [留言页](/cn/docs/hugo/features/message): 创建由当前评论服务驱动的独立留言页。
    - [即刻短文](/cn/docs/hugo/features/brevity): 从 data/brevity.yaml 发布短动态。
    - [最新评论](/cn/docs/hugo/features/recent-comments): 将最新评论聚合到独立页面和侧栏模块。
    - [图库](/cn/docs/hugo/features/gallery): 使用 Solitude Hugo Shortcodes 组合响应式图库。
  - 集成服务
    - 搜索
      - [本地搜索](/cn/docs/hugo/integrations/search/local-search): 生成并使用 Hugo 内建搜索索引。
      - [Algolia](/cn/docs/hugo/integrations/search/algolia): 将 Solitude 搜索连接到 Algolia 索引。
      - [DocSearch](/cn/docs/hugo/integrations/search/docsearch): 配置 Algolia DocSearch 界面。
    - 评论
      - [Twikoo](/cn/docs/hugo/integrations/comments/twikoo): 将 Twikoo 接入 Solitude 文章和特色页面。
      - [Waline](/cn/docs/hugo/integrations/comments/waline): 连接 Waline 服务并按需启用浏览量。
      - [Valine](/cn/docs/hugo/integrations/comments/valine): 配置 Valine 评论、访问量和最新评论数据。
      - [Artalk](/cn/docs/hugo/integrations/comments/artalk): 连接 Artalk 服务与站点标识。
      - [Giscus](/cn/docs/hugo/integrations/comments/giscus): 使用 GitHub Discussions 作为 Solitude 评论后端。
  - 迁移
    - [从 Hexo 迁移](/cn/docs/hugo/migration/from-hexo): 将 Solitude Hexo 站点迁移到 Hugo 原生版本，不携带废弃契约。
  - 常见问题
    - [常见问题](/cn/docs/hugo/faq/common): 解答环境要求、配置归属、更新和部署问题。
    - [故障排查](/cn/docs/hugo/faq/troubleshooting): 排查构建失败、资源缺失、搜索输出和运行时重复行为。
- Hexo: Solitude Hexo 版
  - 快速开始
    - [介绍](/cn/docs/hexo/getting-started/introduction): 了解 Solitude 4 的定位、运行要求与配置模型。
    - [安装](/cn/docs/hexo/getting-started/installation): 安装 Solitude 4，并准备博客根目录中的主题配置。
    - [首次运行](/cn/docs/hexo/getting-started/first-run): 生成 Solitude 4 站点并检查模块是否正确加载。
    - [升级到 4.0](/cn/docs/hexo/getting-started/upgrade-v4): 将 Solitude 3.x 博客迁移到 Solitude 4.0 的原生 ES 模块运行时。
  - 配置
    - [站点配置](/cn/docs/hexo/configuration/site): 配置 Hexo 站点身份与 Solitude 站点标记。
    - [导航菜单](/cn/docs/hexo/configuration/navigation): 配置菜单、分组、右侧按钮和右键菜单。
    - [首页配置](/cn/docs/hexo/configuration/home): 配置顶部横幅、推荐位、分组和文章列表。
    - [侧边栏](/cn/docs/hexo/configuration/sidebar): 配置侧栏组合、作者信息、目录、标签和站点统计。
    - [文章配置](/cn/docs/hexo/configuration/posts): 配置文章默认值、元信息、分享、过期提醒和相关文章。
    - [SEO](/cn/docs/hexo/configuration/seo): 配置 Hexo 规范元数据、Open Graph、站点验证、robots 和 sitemap。
    - [外观配置](/cn/docs/hexo/configuration/appearance): 配置 v4 颜色、显示模式、字体、加载效果、代码高亮和图片。
    - [高级配置](/cn/docs/hexo/configuration/advanced): 配置可选渲染、PWA、注入、界面、广告和 CDN 功能。
    - [浏览器 API](/cn/docs/hexo/configuration/browser-api): 通过 Solitude 4 的公开浏览器 API 与 PJAX 生命周期开发扩展。
  - 内容写作
    - [Front Matter](/cn/docs/hexo/content-writing/front-matter): 使用经过验证的 Hexo 与主题字段控制文章和页面。
    - [主题标签](/cn/docs/hexo/content-writing/tags-plugin): 安装并使用 Solitude 标签插件已验证的语法。
  - 特色页面
    - [音乐馆](/cn/docs/hexo/features/music): 创建主题内建的 Meting 音乐页面。
    - [即刻短文](/cn/docs/hexo/features/brevity): 创建主题内建的短文时间线及其数据源。
    - [关于页](/cn/docs/hexo/features/about): 使用 source/_data/about.yml 构建主题内建关于页。
    - [友情链接](/cn/docs/hexo/features/links): 配置友链数据与 v4 异步渲染。
    - [我的装备](/cn/docs/hexo/features/equipment): 创建主题内建装备页及其分组数据。
    - [留言板](/cn/docs/hexo/features/message): 使用评论服务和弹幕创建主题内建留言页。
    - [最近评论](/cn/docs/hexo/features/recent-comments): 从已启用评论服务创建主题内建最近评论页。
    - [追番页面（第三方）](/cn/docs/hexo/features/bangumi): 通过第三方 hexo-bilibili-bangumi 插件添加追番列表。
    - [相册（第三方）](/cn/docs/hexo/features/gallery): 通过第三方 hexo-gallery 标签插件嵌入瀑布流相册。
  - 集成服务
    - 搜索
      - [本地搜索](/cn/docs/hexo/integrations/search/local-search): 生成本地 XML 索引并启用 Solitude 4 搜索模块。
      - [Algolia 搜索](/cn/docs/hexo/integrations/search/algolia): 将 Solitude 4 搜索界面连接到 Hexo Algolia 索引。
      - [DocSearch 搜索](/cn/docs/hexo/integrations/search/docsearch): 在 Solitude 4 中配置现有 Algolia DocSearch 索引。
    - 评论系统
      - [Twikoo 评论](/cn/docs/hexo/integrations/comments/twikoo): 将 Twikoo 配置为 Solitude 4 顶层评论服务。
      - [Waline 评论](/cn/docs/hexo/integrations/comments/waline): 将 Waline 配置为 Solitude 4 顶层评论服务。
      - [Valine 评论](/cn/docs/hexo/integrations/comments/valine): 将 Valine 配置为 Solitude 4 顶层评论服务。
      - [Artalk 评论](/cn/docs/hexo/integrations/comments/artalk): 将 Artalk 配置为 Solitude 4 顶层评论服务。
      - [Giscus 评论](/cn/docs/hexo/integrations/comments/giscus): 将 Giscus 配置为 Solitude 4 顶层评论服务。
  - 常见问题
    - [常见问题](/cn/docs/hexo/faq/common): 解答 Solitude 4 安装、配置和升级中的常见问题。
    - [故障排查](/cn/docs/hexo/faq/troubleshooting): 排查 Solitude 4 构建、ES 模块、PJAX、数据文件、搜索和评论问题。