Page Mata

对于 Web 页面发布的场景，我们可能期望能控制最终页面的 URL。

飞书知识库的默认功能并未给我们提供一些特殊的描述字段用于定义页面 URL 之类的信息。因此我们需要采用一个特殊的方法来实现这个描述。

语法格式

Page Meta 是 feishu-pages 项目里面的一个特殊描述信息，你可以在飞书文档第一段插入一个 CodeBlock 并采用 YAML或JSON的语言格式。

最终页面导出的时候 feishu-pages 工具将会识别这个 CodeBlock 里面的内容，用来作为这一页的描述（或者是配置信息）信息。

字段	类型	说明
slug	string	用来定义页面的 URL 文件名。 例如：hello-world 这样，最终的 URL 地址可能会是这样： https://your-site.com/path/of/folder/hello-world path/of/folder 是左侧目录树的层次
hide	bool	隐藏此页，如果为 true 当前页面以及它的子页面在生成最终 Page 的时候将会被忽略，目录树里面也不会有。 默认值：false

如果是采用 YAML 格式，编写 Page Meta 部分类似这样：

slug: your-page-slug
hide: false

你也可以采用 JSON 格式，效果是一样的：

{
  "slug": "your-page-slug"
}

当我们完成 Page 生成以后，Page Meta 将会被隐藏掉，不会在最终的网页上显示出来。

💡

如果你觉得每篇文档设置 slug 太麻烦，可以通过设置 URL_STYLE=original 来采用飞书文档这种简单的 URL 结构，这样文档就不需要写 slug 了。

详见：URL Style

例如

下面这是一个飞书文档上配置了 Page Meta 的截图举例，添加了 Page Meta 页面看起来可能是这样的：