LumiDoc 独特格式
注
这个文档将会让你学习到有关第三方插件的使用、与文档必要的 FrontMatter 配置。
FrontMatter 配置
介绍 FrontMatter
FrontMatter 将被用于每个文档的开头，决定了文档的各种必要信息，如标题、发布时间、作者名称与作者链接、标签等。如下是一个实例：
---
title: 我是文档标题
date: 1999-05-20
author: 我是作者
---LumiDoc 会在文档开头识别---来确认是否存在 FrontMatter。请确保文档开头一定存在 FrontMatter 配置，以便于 LumiDoc 进行自动配置。
快速上手 FrontMatter
只要在文档的最开头加上下面的内容，即完成了最基础的 FrontMatter 配置。
---
title: [在此填入文档的标题]
date: [在此填入文档完成创作的日期，格式为 YYYY-MM-DD]
author: [在此填入作者名称]
---注
你可以快速复制上面的代码块并粘贴至文档开头部分。
FrontMatter 元素列表
| 元素名称 | 含义 | 类型 | 备注 |
|---|---|---|---|
| title | 文档标题 | 文本型 | 这决定了文档的标题。如果不填，则默认为正文中首个一级标题。 |
| order | 文档顺序 | 数字型 | 如果要发布多个文档，可以在这里列出文档顺序，有助于 LumiDoc 的目录生成与上下文连接。 |
| description | 文档简述 | 文本型 | 对文档的简要描述。 |
| author | 作者名 | 文本型 | 作者名将决定文档归属权与责任承担方。 |
| isOriginal | 原创判断 | 判断型 | 如果文档是转载的，需要填false。 |
| date | 文档发布日期 | 日期型YYYY-MM-DD | 如果对文档有修改，时间也应更新。LumiDoc 不会自动撰写日期。 |
| license | 文档协议 | 文本型 | ⚠️警告：这将修改文档的开源协议，请谨慎填写。 |
| copyright | 文档版权归属 | 文本型 | ⚠️警告：当更改了文档的版权归属后，LumiDoc 将完全不会对该文档负任何责任，责任归属将完全转移至author。 |
特殊情况的 FrontMatter 配置
如果文档有多个作者：
---
author:
- [作者1]
- [作者2]
...
---如果文档作者需要个人链接：
---
author:
- name: [作者1]
url: [作者1的链接]
email: [作者1的邮箱]
- name: [作者2]
url: [作者2的链接]
email: [作者2的邮箱]
---Badge 角标
Badge 角标<就是我是在文档内显示在正文作短提示的内容。类似于以下使用场景：
新版本v1.9.2
测试版Beta2
Badge 角标采用 HTML <Badge />编写。如上的使用场景代码如下：
新版本 <Badge text="v1.9.2" type="tip" />
测试版 <Badge text="Beta2" type="warning" />以上的text=""和type=""是 HTML 格式常见的 属性。在 Badge 角标中，有以下常见的属性：
- text="" 欲显示的文字
- type="" Badge 的类型，通常有：tip｜warning｜danger｜important｜info(默认是我)｜note
- color="" Badge 的颜色。使用 CSS 颜色值。
- vertical="" Badge 的垂直方向与位置。常见的有
"top" | "middle" | "baseline" | "bottom"
分享按钮
如果文档需要被分享至第三方平台，可以使用<Share />来快速添加分享按钮，比如下面是直接使用<Share />代码即可生成出的按钮：
注意
分享功能暂时存在适配缺陷，截至 2025 年 12 月 1 日，只能分享至国外平台。等待修复中。
BiliBili 视频嵌入
要想直接在文档里加入 B 站视频，可以直接采用 <BiliBili bvid="在这填入 BV 号" /> 来直接插入。除了 bvid= 外，还存在一些别的属性：
- bvid= 用于指示视频 BV 号。
- time= 自定义空降位置，按 秒 为单位。如想空降至 1:20 的位置，则在该属性内填写
80。 - page= 选择分 P。如果没有分 P 可不填。一旦有分 P 时，下面两个属性必填。
- aid= 指示视频的 aid。（即视频的 av 号）获取方法请先自行网上搜索，将在未来添加进 LumiDoc 官方教程中。
- cid= 指示视频的 cid。（即视频的对应 弹幕池）
左对齐、右对齐与 中心对齐
我在左边
我在中间
我在右边
这是两端对齐的内容
以上的代码如下：
::: left
<i class="fa-solid fa-align-left"></i>我在左边
:::
::: center
<i class="fa-solid fa-align-center"></i>我在中间
:::
::: right
<i class="fa-solid fa-align-right"></i>我在右边
:::
::: justify
这是两端对齐的内容
:::可以直接采用 ::: [对齐方向] 的格式来规划文本对齐的方向。注意内容结束时要用 ::: 包围欲改变的内容。
FontAwesome 图标支持
LumiDoc 直接支持 FontAwesome 的图标：
如果你需要任何图标，可以打开这个链接：FontAwesome 图标搜索
只需要在网页内搜索想要的图标（英文），点开后会有一段代码链接，比如<i class="fa-solid fa-globe"></i>。可以直接将代码输入到文档，LumiDoc 会自动识别并显示。