Beex 配置(_config.toml) 9029 | 特厉害计划
  • Why Github?
  • Team
  • Enterprise
  • Explore
  • Marketplace
  • Pricing
Sign inSign up
Watch996
Star102.4k
Fork61.8k
Branch: beex.help
Switch branches/tags
Branches
Tags
  •  
K / Beex 配置(_config.toml).md
122 lines 7.58 KB
First commit on 15 Jun 2020

    下面的每一项在 _config.toml 文件中都有默认值,你可以对比阅读,如果你懂得 TOML 的语法那就太好了。不懂也没关系,你只需要注意:大部分值被引号括起来,一些数字类型的值没有引号,修改时不要误删引号。

    这个文件的第一行是版本信息 version,为了以后扩展使用。目前不用管它。

    Beex 有多站点的概念,而且只是逻辑上的,这使得它们是可以混合的,配置内容默认如:

    version = '0.1.0'
    [sites.1]
    title = 'My First Site'
    # some settings...
    

    这表示这些配置是针对 sites.1 这个站点的。你只能用数字命名站点,当你想增加站点时,复制这些内容在下面,然后改一个名字,比如:

    version = '0.1.0'
    [sites.1]
    title = 'My First Site'
    # some settings...
    [sites.2]
    title = 'My Second Site'
    # some settings...
    

    下面是具体的配置说明:

    • title: 站点标题。默认值是用三个单引号括起来的标题,title = '''Site's Title''',这是因为标题里还带有一个单引号。如果你的标题不需要使用单引号,可以改为 title = 'My Website',保持三个单引号 title = '''My Website''' 也行。

    • source: 源文件的根目录,也就是你保存 .md 文件的位置。

    • target: 目标的根目录。(输出 .html 文件的目录。)

    • trash: 回收站,也是一个文件夹,模拟回收站的功能,当你发布了某篇文章之后又将其隐藏时,之前生成的 .html 文件会移动到这个文件夹。

    • theme: 使用的主题。(文件夹的名字。主题全部在 _themes 文件夹中。)

    • author: 作者名。

    • new_dir_name_format: 当你 new 时,新建的文件夹命名格式,直接举例:

      • 如果是 new_dir_name_format = '{yyyy}-{mm}-{dd}-{title}',当你通过 bx new foo 新建一篇文章时,目录名会以当天的日期命名为类似 2020-06-07-foo 这样的格式。注意不要用 / \ 之类的特殊字符。

      • 可用的占位符:

        • {title}: 标题
        • {yyyy}: 年
        • {mm}: 月
        • {dd}: 日
        • {short}: short
    • new_file_name_format: 新建的文件命名格式,无需后缀,参考 new_dir_name_format

    • archive_title_format: 文章标题的命名格式,可以独立于文件名,参考 new_dir_name_format

    • archive_target_format: 文章相对于 target 的目标位置,注意不要用 /\ 开头,否则 .html 会输出到盘符根目录下。

      • 比如 target = './html'archive_target_format = 'posts/{title}.html',则生成的页面位于 ./html/posts/{title}.html
    • archives_target_format: 全部文章的列表页相对于 target 的位置。虽然这个字段名带 _format 后缀,但是目前没有可用的占位符用于替换,因为该列表页只有一个。

      • 如果你的首页没有文章列表,则可以用这个页面作为文章的索引页。
    • categories_target_format: 全部分类的列表页。参考 archives_target_format

    • category_target_format: 每一个分类的文章列表页相对于 target 的位置。

      • 只对新增的分类有效,正在使用的分类不会被修改。

      • 如果要修改正在使用的分类的元信息,在 _beex 目录里你会看到相应文件。

      • 可用的占位符(至少要使用其中一个,不然分类页会互相覆盖):

        • {title}: 分类标题
        • {short}: short
    • tags_target_format: 全部标签的列表页。参考 archives_target_format

    • tag_target_format: 每一个标签的文章列表页,参考 category_target_format

    • tagline: 站点副标题。

    • image_quality: Jpeg 图片的质量。(1 - 100)

    • image_max_weight: 图片最大宽度。(px)

    • image_max_height: 图片最大高度。(px)

    • port: 启动 HTTP 服务时使用的端口。

    • language: 站点语言。(相关功能还没实现,事实上我不准备实现。^_^)

    • created: 站点的创建时间,RFC3339 格式。