The documentation is a work in progress, and English edition is just an empty shell for now. I will translate it when Chinese edition has done.
Flags 是形如 @tags: a, b, c
的一组标记(注意使用英文冒号),用于提供描述页面的元数据(我认为 @
标记更加灵活简易,没有选用较为常见的 YAML 格式)。
所有 Flag 标记都是可选的,每条需要单独占据一行,个别可以填入多项数据(用中英文逗号或中文顿号分隔)。多次出现的同类 Flag 会以最后一条为准。它们最后都会从文件内容中剔除,部分会展示在页头或者页脚。
title
:页面标题。它是一个特殊 Flag,不使用 Flag 标记语法,而是识别 Markdown 的顶级标题(# title
)。如果文件的第一行没有顶级标题,它就是文件的路径(省略index.md
)。@tags
:文件标签,可以嵌套(a/b/c
),支持多项。@updated
:更新日期 / 时间,支持多项(只会选取最旧和最新的时间进行展示)。没有严格的格式要求,只要能被new Date()
解析就行。如果它全部由数字组成,会被作为时间戳(含毫秒)传入。除了使用 Flag,你也可以在文件路径中包含一个格式固定的日期(/YYYY/MM/DD/
(正则表达式:/\/(\d{4}[/-]\d{2}[/-]\d{2})[/-]/
),除了第一个/
是必须的,其它都可以替换为-
),它会合并进updated
。@cover
:页面头图,可以直接填入图片地址,也可以使用无alt
的 Markdown 图片语法(
,这主要是为了便于编辑器关联文件)。@creator
:文件创建者,不支持多项。@updater
:文件更新者,不支持多项。- 自定义 Flag:预定义 Flag(
title
、tags
、updated
、cover
、times
、startDate
、endDate
、creator
、updater
,请避免和其中任何一项重名)之外的所有 Flag 标记都是自定义 Flag,不支持多项。
- This page is open source, improve it