跳到主要内容

docs 编写配置

本文字数: 225阅读需 1 分钟

类别元数据

示例:

docs/tutorials/_category_.json
{
"position": 2.5,
"label": "教程",
"collapsible": true,
"collapsed": false,
"className": "red",
"link": {
"type": "generated-index",
"title": "教程总览"
},
"customProps": {
"description": "这个描述可以用在 swizzle 的 DocCard 里"
}
}

文档项目元数据

示例:

---
id: doc-markdown
slug: /myDoc
title: 文档 Markdown 特性
description: 我解决不了这个问题时在哪里找到你
// 是否隐藏文档顶部显示的标题。
hide_title: false
// 是否隐藏右侧的文档目录。
hide_table_of_contents: false
sidebar_label: Markdown
sidebar_position: 3
// 这篇文档在上一篇/下一篇按钮中显示的文本
pagination_label: Markdown 特性
keywords:
- docs
- docusaurus
image: https://i.imgur.com/mErPwqL.png
// 表明文档处于未完成状态。 文档草稿只会在开发模式下显示。
draft: true
last_update:
date: 1/1/2000
author: 自定义作者名
---

# Markdown 特性

我的 Markdown 文档的内容
Loading Comments...