Simiki

配置

配置文件是 _config.yml.

注意: 一般情况下, 只需要配置好初始配置文件中给出的配置项.

配置选项

配置选项 说明 默认值
url 站点域名 ""
title 站点标题. 用于网站的一些元信息 ""
keywords 站点的关键字. 用于网站的一些元信息 ""
description 站点的描述信息. 用于网站的一些元信息 ""
author 站点作者 ""
root 站点根目录. 大部分情况下不需要填写, 使用默认值即可.
如果站点使用子目录, 如http://example.com/wiki/, 则需要设置urlhttp://example.com/wiki/, 并且设置root/wiki/.
通常是在使用Github Pages - Project的情况下才需要配置此选项
"/"
source 存储源文件(目前暂时只支持Markdown)的目录. 不建议修改默认值 "content"
destination 存储生成的静态文件的目录. 不建议修改默认值 "output"
attach 存储附件文件(如图片,压缩包等)的目录.
此目录在生成时会拷贝到output目录, 即attach/path/to/file会拷贝到output/attach/path/to/file.
另外此目录默认没有创建, 如果需要可以手工创建. 不建议修改默认值
"attach"
themes_dir 存储所有主题的目录. 一个主题一个子目录, 全部存放在此目录下. 不建议修改默认值 "themes"
theme 指定使用的主题名. 主题名即存放在themes_dir目录下的主题目录名 "simple"
category 目录的自定义配置, 如目录别名、描述等. 生成时通过pages变量获取. 具体见下面的样例 None
default_ext simiki new生成一篇wiki时的默认后缀 "md"
pygments 设置true为开启代码高亮 true
debug 设置true为开启调试模式, 会输出更多更详细的信息 false

以上只列出站点全局的基本配置选项, 其它选项见相应的文档:

样例

url: http://simiki.org
title: Simiki
keywords: simiki, wiki, python, simple
description: Simiki is a simple static site generator for wiki.
author: Tanky Woo

root: /
source: content
destination: output
themes_dir: themes
theme: cod

category:
  - name: linux  # 目录名
    label: Linux/运维  # 目录的别名, 生成首页时可以使用
  - name: database
    label: 数据库

default_ext: md
pygments: true
debug: false