• Why Github?
  • Team
  • Enterprise
  • Explore
  • Marketplace
  • Pricing
Sign inSign up
Watch996
Star102.4k
Fork61.8k
Branch: working.beex.help
Switch branches/tags
Branches
Tags
  •  
K / BeexMeta.md
Go to Mobile Clone
加载中...
到移动设备上浏览
68 lines 4.76 KB
First commit on 16 Jun 2020

    BeexMeta 只是简单地用 : 分隔的键值对,会在 bx new 时自动添加到 .md 文件头部,并且不区分数据类型

    默认字段形如:

    <!-- BeexMeta
    title:
    target:
    categories:
    tags: 
    created:
    short:
    -->
    

    titletarget 的格式可以在 _config.toml 中编辑。

    字段说明

    • title: 页面标题。

    • target: 页面在生成网站时,相对于 _config.tomltarget 目录的生成位置。

      • 不要/ 开头,生成网站时会在 URL 开头自动加 /
      • 如果你使用 Github Pages 之类的服务,则不要包含空格和中文,因为我没有 encode 目标文件名,这是为了本机上的人类可读性。(也许未来会修改此条。)0.6.0 之后完全支持 UTF-8 文件名。
      • 如果你用 index.html 做文件名,类似 target: post/foo/index.html,生成的 URL 会是 /post/foo/,即自动删除了 index.html,所以当你在别的文章引用这篇的时候,你需要这样写:[foo](/post/foo/)。如果需要发布网站,你可能需要在服务器上的配置隐藏 index.html 的规则,本地使用不受任何影响。
    • categories: 分类列表,用中文或英文逗号分隔,不使用空格 space 分隔。

    • tags: 标签列表,参考 categories

    • created: 本页面创建时间,RFC3339 格式。就是年月日和时分秒之间用字母 T 连接,带纳秒,带时区。

    • short: 本页的 short

    除了上面自动生成的,你还可以手动添加:

    • sticky: 置顶,正整数,除了 0 表示不置顶外(也就是所有文章的默认值),数字越小越靠上。

    • hidden: 是否隐藏此篇文章。如果设置为 1,则生成网站时此篇文章不会输出到网站中。如果是在生成网站后从 0 改为 1,已生成的 .html 文件会被删除(移动到 trash 中)。

    0.3.0 新增:

    • inlist: 默认为 1,表示在首页和各个列表页中都显示此文档。如果被设置为 0,表示不出现在列表中,但页面是可以访问的。这很像其他 CMS 中对 文章页面 的区分。

    • template: 指定使用的模板文件,该文件位于主题文件夹里名为 templates 的子文件夹内。如果模板文件不存在,则使用默认模板渲染页面。

    0.8.0 新增:

    • thumbnail:缩略图,图片链接。

    • previous:上一篇,使用 Markdown 语法:

    • next