本页目录

文档元数据

你可以使用以下函数来设置文档信息。按照惯例，你应该在 Quarkdown 源文件的起始位置调用这些函数。

名称	可接受的值	默认值
`.docname`	文档的名称。	`Untitled Quarkdown Document`
`.docdescription`	文档的简短描述。	(空)
`.docauthors`	文档的作者。	(空)
`.dockeywords`	与文档关联的关键词，以可迭代对象的形式。	(空)
`.doctype`	输出文档的类型：`plain`、`slides`、`paged`、`docs`。更多信息请参阅文档类型。	`plain`
`.doclang`	文档的语言：可以是不区分大小写的英文完整名称（如 `English`、`Italian`、`French (Canada)`），也可以是 IETF BCP 47 语言标签（如 `en`、`it`、`fr-CA`）。该设置定义了内容本地化的目标区域、针对特定区域（如中文区域使用的中文字体）的样式，以及用于连字符与无障碍的 HTML `lang` 属性。了解更多请参阅本地化。	(无)

修改或回显

所有这些函数都具有修改或回显的行为：如果你不带参数调用它们，它们会返回之前设置的值：

示例 1

.docname {Quarkdown}

This document is named **.docname**!

This document is named Quarkdown!

作者

.docauthors 函数用于设置文档的作者。

.docauthors
    - John Doe
    - Jane Doe

该函数将一个 Dictionary 作为其值，其中每个键是作者的姓名，值是包含作者信息的嵌套字典。你可以使用的信息条目没有任何限制。

.docauthors
    - John Doe
        - email: johndoe@example.com
        - website: example.com
    - Jane Doe
        - email: janedoe@example.com
    - company: GitHub

不带参数调用该函数会返回字典本身，你可以遍历它，按照自定义布局来显示作者。

示例 2

.foreach {.docauthors}
    name info:
    .row gap:{1cm}
        **.name**

        .info::get {email}

John Doe

johndoe@example.com

Jane Doe

janedoe@example.com

单一作者

如果文档只有一位作者，并且你不需要额外信息，可以使用 .docauthor {name} 作为简写。

无论你使用 .docauthors 还是 .docauthor 来定义作者，不带参数调用 .docauthor 都会返回作者的姓名。

.docauthor {John Doe}

关键词

.dockeywords 函数将文档的关键词设置为一个可迭代对象。

当将文档导出为 HTML 时，这些关键词被用于搜索引擎优化（SEO）。

.dockeywords
  - markdown
  - typesetting
  - papers