gitype

基于 Git 的博客系统，具有以下特性：

1. 无数据库，通过 Git 管理发布的内容；
2. 无分类，通过标签来归类；
3. 不区分页面和普通文章；
4. 可以实时搜索内容；
5. 自动生成 RSS、Atom、Sitemap 和 Opensearch 等内容；
6. 自定义主题。

演示地址： https://caixw.io

使用

1. 下载代码：go get github.com/caixw/gitype；
2. 运行 scripts/build.sh 编译代码（也可以直接执行 go build 编译，除了版本号，并无其它差别。）；
3. 执行 gitype -init=/to/path 输出初始的数据内容；
4. 运行 gitype -appdir=/to/path。

./scripts 目录下包含了部分平台下的转换成守护进程的脚本 ./testdata 也是一个完整的工作目录，如果不想执行 -init 命令初始化的话，也可以直接复制 ./testdata 的内容。

目录结构

appdir 的目录结构是固定的。 其中 conf 为程序的配置相关内容，包含了后台更新界面的密码，不能对外公开； data 为博客的实际内容，包含了文章，标签，友链以及网站名称等相关的配置， 所有针对博客内容的相关设置和内容发布，都直接体现在此目录下。

|--- conf 程序的配置文件
|     |
|     |--- logs.xml 日志的配置文件
|     |
|     |--- app.yaml 程序的配置文件
|
|--- data 程序的数据目录
      |
      |--- meta 博客的一些设置项
      |     |
      |     |--- config.yaml 基本设置项，比如网站名称等
      |     |
      |     |--- tags.yaml 标签的定义
      |     |
      |     |--- links.yaml 友情链接
      |
      |--- posts 文章所在的目录
      |
      |--- raws 其它可直接通过地址访问的内容可直接放在此处
      |
      |--- themes 自定义的主题目录
            |
            |--- default 默认的主题

conf 目录下内容

conf 目录下的为程序级别的配置文件，需要重启才能使更改生效。其中：

• app.yaml 定义了诸如端口，证书等基本数据；
• logs.xml 定义了日志的输出形式和保存路径，具体配置可参考 logs 的相关文档。

app.yaml

Webhook

data 目录下内容

涉及的时间均为 RFC3339 格式：2006-01-02T15:04:05Z07:00。

meta/config.yaml

config.yaml 指定了网站的一些基本配置情况：

Author

Archive

RSS

Sitemap

Opensearch

Icon

Link

Page

部分页面可使用 %content% 占位符，分别是表示网站名称和可自由取代的内容，比如 tag 页面，%content 会用标签名代替

tag 和 post 页面的 keywords 和 description 是不可更改的

meta/links.yaml

links.yaml 用于指定友情链接，为一个数组。每个元素均为一个 Link。 每个元素可以使用 XFN。

meta/tags.yaml

tags.yaml 用于指定所有的标签内容。为一个数组，每个元素包含以下字段：

posts

data/posts 为文章目录，目录层次可以按自己的习惯进行分类，系统根据是否包含 meta.yaml 和 content.html 来区分当前目录是否为一篇文章内容。比如：

--- posts
      +--- about
      |      |
      |      +--- meta.yaml
      |      |
      |      +--- content.html
      |
      +--- 2016
      |
      +--- 2017
            |
            +--- post1
            |      |
            |      +--- meta.yaml
            |      |
            |      +--- content.html
            |
            +--- post2
                   |
                   +--- meta.yaml
                   |
                   +--- content.html

其中 /posts/about、/posts/2017/post2 和 /posts/2017/post2 均被判断为文章。

meta.yaml

meta.yaml 包含了当前文章的一些细节信息。

themes

data/themes 下为主题文件，可定义多个主题，通过 config 中的 theme 指定当前使用的主题。 主题模板语法为 html/template。

单一主题下，可以为文章详细页定义多个模板，通过每篇文章的 meta.yaml 可以自定义当前文章使用的模板， 默认情况下，使用 post 模板。

错误模板

400 及以上的错误信息，均可以自定义，方式为在当前主题目录下，新建一个与错误代码相对应的 HTML 文件， 比如 400 错误，会读取 400.html 文件，以此类推。但是只能是纯 HTML 文本，不能包含模板代码。

raws

当访问的页面不存在时，会尝试从 raws 下访问相关内容。比如 /abc.html，会尝试在查找 raws/abc.html 文件是否存在；甚至 /post/2016/about.htm 这样标准的文章路由，如果文章不存在，会也访问 raws 目录，查看其下是否在正好相同的文件。

版权

本项目采用 MIT 开源授权许可证，完整的授权说明可在 LICENSE 文件中找到。