Skip to content

Commit

Permalink
完善更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
FromEndWorld committed Jun 29, 2019
1 parent 066e995 commit d92a396
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 7 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ LOFFER是个可以帮助你get off from LOFTER的软件(我知道这个pun很

**LOFFER已更新到V0.2.0版本**

新版本进一步优化了一下样式,并且支持了基于GitHub Issues的评论Gitalk。比Disqus好看多了!!!
新版本进一步优化了一下样式,并且支持了基于GitHub Issues的评论Gitalk(请看下文的配置说明)。

如果你已经fork了LOFFER,想要更新到新版本的话
如果你已经fork了LOFFER,想要更新到新版本的话,可以试试[这个方法](https://github.com/KirstieJane/STEMMRoleModels/wiki/Syncing-your-fork-to-the-original-repository-via-the-browser),或者你也可以干脆删掉重来,只要保留自己的大部分config设定和所有的post就好。

LOFFER只是容器,你的posts才是博客的核心。


## 注意
Expand Down
38 changes: 33 additions & 5 deletions _posts/2019-06-02-document.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,18 @@ categories:
tags: [sample, document]
comments: true
---

LOFFER是个可以帮助你get off from LOFTER的软件(我知道这个pun很烂)。

这是一个可以通过Fork直接发布在GitHub的Jekyll博客,你不需要编写代码或使用命令行即可获得一个部署在GitHub的博客。

当你看到不认识的术语,请忽略它,我知道程序员不说人话,我都不是程序员但是我已经开始意识到这是因为我们不知道这些概念用人话怎么说。
**LOFFER已更新到V0.2.0版本**

新版本进一步优化了一下样式,并且支持了基于GitHub Issues的评论Gitalk(请看下文的配置说明)。

如果你已经fork了LOFFER,想要更新到新版本的话,可以试试[这个方法](https://github.com/KirstieJane/STEMMRoleModels/wiki/Syncing-your-fork-to-the-original-repository-via-the-browser),或者你也可以干脆删掉重来,只要保留自己的大部分config设定和所有的post就好。

LOFFER只是容器,你的posts才是博客的核心。

以下我会尽量用人话解说如何使用这个……LOFFER。

## 注意

Expand All @@ -27,6 +31,7 @@ LOFFER是一个**博客模板**,使用GitHub Pages发布个人博客是没有

另外,同人作品更好的发布平台是[AO3](https://archiveofourown.org/),你想你发在AO3还有tag还有kudos还有人看,是吧?


## 如何使用

首先,这个博客主题适应手机阅读,但是,要使用它建立你自己的博客,你需要上电脑操作。
Expand Down Expand Up @@ -63,7 +68,6 @@ LOFFER是一个**博客模板**,使用GitHub Pages发布个人博客是没有

还有一点,**LOFFER使用的是MIT协议,大意就是全部开源随意使用,如果你要保留自己博文的权利,请编辑LICENSE文件,写上类似“_posts中的文档作者保留权利”这样的内容。**


### 第三步 发布博文

在你的博客的GitHub代码库页面里,点开_posts文件夹,这里面就是你的博客文章。
Expand All @@ -86,7 +90,7 @@ LOFFER是一个**博客模板**,使用GitHub Pages发布个人博客是没有
comments: true
---

完成后,保存为.md文件,文件名是date-标题,例如 2019-06-02-document.md (注意这里的标题会成为这个post的URL,所以推荐使用字母而非中文,它不影响页面上显示的标题)然后上传到_posts文件夹,commit,很快就可以在博客上看到新文章了。
完成后,保存为.md文件,文件名是date-标题,例如 2019-06-02-document.md (注意这里的标题会成为这个post的URL,所以推荐使用字母而非中文,它不影响页面上显示的标题)然后上传到_posts文件夹,commit,很快就可以在博客上看到新文章了。

### 可选:图片怎么办?

Expand All @@ -100,6 +104,8 @@ LOFFER是一个**博客模板**,使用GitHub Pages发布个人博客是没有

### 可选:添加评论区

#### Disqus

LOFFER支持Disqus评论,虽然Disqus很丑,但是它是免费的,设置起来又方便,因此大家也就不要嫌弃它。

首先,注册一个[Disqus](https://disqus.com/)账户,我们可以选择这个免费方案:
Expand All @@ -122,6 +128,28 @@ LOFFER支持Disqus评论,虽然Disqus很丑,但是它是免费的,设置

然后需要回到你的博客,修改_config.yml文件,在disqus字段填上你的shortname,commit,完成!

#### Gitalk

新增内容,LOFFER 0.2.0版本支持Gitalk评论区(在LOFFER示例站中仍然是Disqus,可以在[我的博客](https://himring.top/gitalk/)查看Gitalk的demo),设置方法如下:

首先,创建一个[OAuth application](https://github.com/settings/applications/new), 设置如图:

![img](https://raw.githubusercontent.com/FromEndWorld/LOFFER/master/images/application_settings.png)

点Register后就会看到你所需要的两个值,clientID和clientSecret,把它们复制到你的_config.yml文件中相应的字段:

gitalk:
clientID: <你的clientID>
clientSecret: <你的clientSecret>
repo: <你的repository名称>
owner: <你的GitHub用户名>

然后commit,你的Gitalk评论区就会出现了。对于每一篇文章,都需要你来进入文章页,来初始化评论区,这一操作会在你的repository上创建一个Issue,此后的评论就是对这个Issue的回复。

你可以进入你的repository的Issue页面,点**Unsubscribe**来避免收到大量相关右键。

注意:出于很明显的原因,最好不要同时添加Disqus和Gitalk评论区。

### 导入LOFTER的内容

这部分由于LOFTER的导出文件十分~~优秀~~,需要另外解决。
Expand Down

0 comments on commit d92a396

Please sign in to comment.