Start typing to search

Press ESC to close
沉浸

知识库搭建

知识库(Wiki)搭建

知识库适合发布成体系的文档或教程,支持层级目录、侧边栏导航和封面页,类似 Wiki 或在线文档。

文件位置

知识库存放在 src/content/docs/ 目录下,使用 Markdown 格式(.md)。

创建知识库

src/content/docs/ 下新建一个目录,目录名即知识库的标识:

src/content/docs/
└── my-tutorial/           ← 知识库目录
    ├── _meta.md           ← 知识库元信息
    ├── index.md           ← 封面页
    ├── getting-started.md ← 第一章
    └── advanced/          ← 子目录
        └── config.md      ← 子章节

_meta.md — 知识库元信息

每个知识库需要一个 _meta.md 文件,填写基本信息:

---
title: 我的教程
description: 从零开始学习搭建博客
order: 1
cover: ../../assets/images/tutorial-cover.jpg
dirs:
  getting-started: 快速开始
  advanced: 进阶配置
---
字段必填说明
title知识库标题
description知识库描述
order排序权重,数字越小越靠前
cover封面图,用于知识库列表页
dirs子目录的中文名称映射

普通文档

知识库中的普通文档:

---
title: 安装与启动
order: 1
---

## 环境要求

...

## 安装步骤

...
字段必填说明
title文档标题
order在侧边栏中的排序位置

知识库列表页

所有知识库展示在 /docs 页面。每个知识库以卡片形式呈现,包含封面图、标题和描述。

封面页

知识库可以设置一个封面页(splash),作为进入知识库的第一个页面:

---
title: 我的教程
splash:
  enabled: true
  backgroundImage: /images/splash-bg.jpg
  buttonText: 开始学习
---

封面页会显示大图背景、标题和一个”开始学习”按钮,点击后进入正文。

使用建议

  • 一个知识库聚焦一个主题,比如”Astro 入门教程”或”摄影后期指南”
  • order 控制章节顺序,让读者按正确的顺序阅读
  • 子目录用 dirs 配置中文名称,侧边栏显示更友好
未知标题
00:00
00:00
播放列表