Skip to content

04 如何文档排序

如何安排文档的结构

src/content/docs/guides/
├── 01-入门/
│ ├── 01-安装.md
│ ├── 02-配置.md
│ └── 03-部署.md
├── 02-基础/
│ ├── 01-markdown.md
│ └── 02-组件.md
└── 03-进阶/
├── 01-自定义.md
└── 02-插件.md

实际代码中

无论是md还是mdx都要加上---内的内容,title和description是必须的 如果是mdx,则支持一些结构导入,比如卡片化的设计

---
title: 01 创建仓库
description: 构建
sidebar:
order: 1 # 数字越小越靠前
---
import { Tabs, TabItem } from '@astrojs/starlight/components';

URL 路径中最好不要使用中文和空格,这可能会导致一些问题。建议使用英文或者连字符(-)来命名

actions:
- text: 阅读文档
link: /guides/01-getting-started/ ✅ 正确的URL路径