29 lines
1.7 KiB
Markdown
29 lines
1.7 KiB
Markdown
|
---
|
|||
|
|
id: string | 文档的唯一 ID
|
|||
|
|
title: string | 文档文本标题
|
|||
|
|
pagination_label: string | 这篇文档在上一篇/下一篇按钮中显示的文本
|
|||
|
|
sidebar_label：string | 这篇文档在侧边栏中显示的文本
|
|||
|
|
sidebar_position: number | 使用 `autogenerated` 自动生成侧边栏项目时，控制文档在侧边栏中出现的位置顺序。
|
|||
|
|
sidebar_class_name: string | 在使用自动生成侧边栏时，给相应的侧边栏标签一个特殊类名。
|
|||
|
|
hide_title: boolean | 是否隐藏文档顶部显示的标题。 此选项只会隐藏前言中定义的标题，对于 Markdown 文档顶部的标题没有任何影响。
|
|||
|
|
hide_table_of_contents: boolean | 是否隐藏右侧的文档目录。
|
|||
|
|
toc_min_heading_level: number | 目录中显示的最小标题层级。 必须介于 2 到 6 之间，并且小于等于最大值。
|
|||
|
|
toc_max_heading_level: number | 目录中显示的最大标题层级。 必须介于 2 和 6。
|
|||
|
|
pagination_next: string | null | 「下篇文档」按钮链接到的文档 ID。 `null` 会禁用本页的「下篇文档」按钮。
|
|||
|
|
pagination_prev: string | null | 「上篇文档」按钮链接到的文档 ID。 `null` 会禁用本页的「上篇文档」按钮。
|
|||
|
|
parse_number_prefixes: boolean | 是否禁用本文档的数字前缀解析。 另见[使用数字前缀]
|
|||
|
|
custom_edit_url: string | 编辑此文档时要跳转到的 URL。
|
|||
|
|
keywords:
|
|||
|
|
- 用于搜索引擎优化的文档关键词元标签。
|
|||
|
|
description: string | 文档的描述信息
|
|||
|
|
image: string | 显示文档链接时所用的缩略图或封面。
|
|||
|
|
slug: string | 自定义文档的 URL
|
|||
|
|
tags:
|
|||
|
|
- 文档标签
|
|||
|
|
draft: boolean | 表明文档处于未完成状态
|
|||
|
|
last_update:
|
|||
|
|
date: 1/1/2000
|
|||
|
|
author: 自定义作者名
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
一篇文档 - 完全模板
|