Git Press +简单快捷的在Github建立网站

Git Press +是一个可以用最简单的方式在Github上建立网站(博客或项目主页)的轻量级的工具。

如果你希望使用Github自带的Github Pages,可以移步:《[译文]为你的项目建立Github Page》

单纯通过以下步骤,你就可以建立你自己的网站:

步骤一:


如果你的项目不存在 README.md (或 README.markdown),你首先需要建立一个README.md (或 README.markdown)。

步骤二:


在你的项目中建立一个空的json文件,命名为: gitpress.json

步骤三:


通过 http://<repo>.<user>.gitpress.org来访问你的站点。

当你推送文件到你的项目时,更新内容会在2-3分钟后生效。


gitpress.json文件示例


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
"docs" : ["posts"],
"template" : "default",
"domain_alias" : ["your.domain"],
"perpage" : 10,
"order" : "number",
"types" : {
"\.(md||markdown)$" : "markdown",
"\.(js||css||json)$" : "code",
"\.html?$" : "html",
".*" : "text"
},
"title" : "Akira's Blog",
"description" : "My Blog Description...",
"comment" : "on",
"friends" : [
{
"name" : "github",
"title" : "github",
"url" : "http://github.com"
},
{
"name" : "gitpress",
"title" : "gitpress",
"url" : "http://gitpress.org"
}
]
}

下面是属性的具体介绍(围观介绍时请对照上面的示例)

docs


docs 属性建立一个文件或目录的列表,此后你可以“放置”你的文件。

这个属性的默认值是 [“README.md”, “README.markdown”, “README”]

template


template 属性用以设置网站的布局,目前唯一有效的属性值是 “default”。

如果你希望通过这个属性来改变你的网站布局,请看 设置网站的布局

domain alias


你的通过gitpress建立的站点的默认域名是 http://repo.user.gitpress.org。当然,你也可以使用自己的域名,请看: 自定义域名

perpage


perpage 属性用以设置你每页显示文章数量的最大值,它的默认值为10。

order


order 属性定义了你文档分类的规则。默认值为 ~text ,这意味着它将按照字符串降序排列。另一个方式是按照文档字数排列,属性值为 ~number。

types


types 属性定义了文章的类型。如果你不希望某些类型的文件出现在你的站点上,你可以设置为 null。

title


title 属性你的GiePress站点的标题,默认值是你的项目名称。

description


description 属性是你的GitPress站点的描述,默认值为你的项目描述。

comment


如果 comment 属性设置为 on, 那么任何人都可以在你的文档中留下评论。

friends


friends 属性,通俗的说就是博客侧栏的友情链接。

设置网站的样式布局


HTML模板是基于 ejs 建立。

你可以克隆(fork) 这个项目, 然后到 www/static/<new template directory>提交你自己的模板。

在新的模板提交以后, pull request给我们, 我们会在第一时间发布这个模板。

一旦新模板发布了,你可以到 gitpress.json中设置 template 属性,将它的属性值改为新模板的目录。

自定义域名


  1. 为你的域名添加一个CNAME记录 <repo>.<user>.gitpress.org。

  2. 编辑 gitpress.json 文件,将你的域名添加到 domain-alias属性中。

  3. 通过老域名访问你的GitPress站点一次,然后尝试使用新域名访问,新域名通常会在2-3分钟后生效。