diff --git a/HISTORY.md b/HISTORY.md index 23bdf4f..021f75c 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,18 +1,18 @@ -#版本历史 +# 版本历史 -##V0.1.1 +## V0.1.1 * 调整目录结构，使开发与部署更加容易，将官方插件全部放到purelog目录下 * 添加Page的功能 * 增加hyde主题 * 增加Command Line Interface模块，用于处理命令行，主要用于部署Purelog和创建求例插件、升级等工作 -##V0.1.0(Beta) +## V0.1.0(Beta) 全新的架构，Purelog分为四个主要部分，分别是Storage/Reduce/Router/Theme，同时也对应着这四个部分的插件。 Purelog只包含核心代码，其它功能都交给插件来做，像主题，存储，数据整理，数据获取，RSS等都由插件实现，Purelog自带有五个插件，分别实现不同的功能。 -###日志 +### 日志 * 全新的架构，分离主题、存储、数据整理为单独的插件 * 增加Tag功能 @@ -22,14 +22,14 @@ Purelog只包含核心代码，其它功能都交给插件来做，像主题， * 增加命令行部署功能，实现`purelog --init`可以部署项目 * 增强对markdown文件的分析功能，允许更多的配置，如日期格式和tags的分隔符 -##V0.0.1(Alpah) +## V0.0.1(Alpah) 这个版本完成的Purelog的基本功能，对应的[Git commit](https://github.com/conis/Purelog/tree/a5ca382b1df4c5d23fbbc76d2263516b9598bb3d) 功能非常简单，架构也很简单，只是为了实现功能，就是可以读取Markdown并生成一个博客。主文件共四个，再加上一个主题。 -###日志 +### 日志 * 实现主题功能，默认使用Ghost的主题 * 实现从Markdown中根据Meta提取文章信息的功能 diff --git a/README.md b/README.md index 3fef1ca..0abafc5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ 如果你憎恨Wordpress的臃肿与性能，如果你想专注于写作，如果你正在或者准备使用Markdown写作，如果希望将你的文章保存到Dropbox或者Github，如果你想获取极高的响应速度，如果你是一个Node.js的开发者，那么你一定要尝试一下[Purelog](http://purelog.org)。 -##Purelog的特点 +## Purelog的特点 * 极速，Purelog在启动的时候，会将博客的文章读取到内存，完全不需要再读取硬盘，所以响应非常快速 * 基于Markdown，Purelog基于文件式的Markdown，这就意味你只需要将Markdown文件保存到某个文件夹就可以了 @@ -9,7 +9,7 @@ * 支持多主题 * 支持插件扩展 -##Purelog适合于哪些人群 +## Purelog适合于哪些人群 * 有自己的VPS或者云主机，如Appflog，总之，你需要Node.js的环境 * 有一定的动手能力，比如说能部署Node.js，会使用简单的命令行，如`npm install -g purelog-cli` @@ -19,9 +19,9 @@ 如果你有两项匹配，我建议你可以尝试一下Purelog。 -#如何使用 +# 如何使用 -##博主 +## 博主 Purelog的安装非常简单，首先要确保你安装了Node.js，然后在命令行按如下步骤： 1. `npm install -g purelog-cli`，注意这里一定要用`-g`的参数 @@ -30,18 +30,18 @@ Purelog的安装非常简单，首先要确保你安装了Node.js，然后在命 只需要简单的三步，你的Purelog就能正常运行了，访问http://localhost:13111就可以访问你的博客了。但这时候Purelog还是默认配置，你需要修改一些简单的配置。[如何修改Purelog的配置](http://purelog.org/configure) -##开发者 +## 开发者 1. `git clone https://github.com/conis/Purelog.git`，将Purelogclone至本地 2. `cd Purelog/purelog` 3. `npm install` 4. `node-dev app.js` -##汇报错误 +## 汇报错误 请提交至 [https://github.com/conis/Purelog/issues](https://github.com/conis/Purelog/issues) -##授权 +## 授权 基于GPL授权 diff --git a/purelog-cli/README.md b/purelog-cli/README.md index 2addddb..6ed9c0c 100644 --- a/purelog-cli/README.md +++ b/purelog-cli/README.md @@ -1,16 +1,16 @@ -#Purelog-cli +# Purelog-cli 用于部署Purelog，以及构建插件的命令行工具 -#安装 +# 安装 `npm install -g purelog-cli` 注意，必需使用-g安装到全局 -#使用 +# 使用 -#安装Purelog +# 安装Purelog 1. 创建Purelog要安装的目录并cd到该目录，如`/var/www/domain.com` 2. 执行`purelog --init' diff --git "a/purelog-cli/boilerplate/app/content/Purelog\346\230\257\344\273\200\344\271\210.md" "b/purelog-cli/boilerplate/app/content/Purelog\346\230\257\344\273\200\344\271\210.md" index 980bffa..0efed39 100644 --- "a/purelog-cli/boilerplate/app/content/Purelog\346\230\257\344\273\200\344\271\210.md" +++ "b/purelog-cli/boilerplate/app/content/Purelog\346\230\257\344\273\200\344\271\210.md" @@ -10,7 +10,7 @@ Excerpt: Purelog是一个轻量快速的，完全基于Markdown的，可扩展 如果你憎恨Wordpress的臃肿与性能，如果你想专注于写作，如果你正在或者准备使用Markdown写作，如果希望将你的文章保存到Dropbox或者Gibhub，如果你想获取极高的响应速度，如果你是一个Node.js的开发者，那么你一定要尝试一下Purelog。 -##Purelog的特点 +## Purelog的特点 * 极速，Purelog在启动的时候，会将博客的文章读取内存，完全不需要再读取硬盘，所以响应非常快速 * 基于Markdown，Purelog基于文件式的Markdown，这就意味你只需要将Markdown文件保存到某个文件夹就可以了 @@ -19,7 +19,7 @@ Excerpt: Purelog是一个轻量快速的，完全基于Markdown的，可扩展 * 支持多主题 * 支持插件扩展 -##Purelog适合于哪些人群 +## Purelog适合于哪些人群 * 有自己的VPS或者云主机，如Appflog，总之，你需要Node.js的环境 * 有一定的动手能力，比如说能部署Node.js，会使用`npm install -g purelog` @@ -29,7 +29,7 @@ Excerpt: Purelog是一个轻量快速的，完全基于Markdown的，可扩展 如果你有两项匹配，我建议你可以尝试一下Purelog。 -##如何安装Purelog +## 如何安装Purelog Purelog的安装非常简单，首先要确保你安装了Node.js，然后在命令行按如下步骤： @@ -39,6 +39,6 @@ Purelog的安装非常简单，首先要确保你安装了Node.js，然后在命 只需要简单的三步，你的Purelog就能正常运行了，访问http://localhost:13111就可以访问你的博客了。但这时候Purelog还是默认配置，你需要修改一些简单的配置。[如何修改Purelog的配置](http://purelog.org/archive/configure.html) -##Github +## Github 作为一个开源系统，Github当然是必需要提供的了：[Purelog on Github](https://github.com/conis/purelog) \ No newline at end of file diff --git "a/purelog-cli/boilerplate/app/content/\345\205\263\344\272\216Purelog\347\232\204\346\225\205\344\272\213.md" "b/purelog-cli/boilerplate/app/content/\345\205\263\344\272\216Purelog\347\232\204\346\225\205\344\272\213.md" index 967a729..35afaab 100644 --- "a/purelog-cli/boilerplate/app/content/\345\205\263\344\272\216Purelog\347\232\204\346\225\205\344\272\213.md" +++ "b/purelog-cli/boilerplate/app/content/\345\205\263\344\272\216Purelog\347\232\204\346\225\205\344\272\213.md" @@ -8,9 +8,9 @@ Tags: 产品,故事, Node.js, Purelog Excerpt: 所有成功的产品，都会有一个故事，对于一个没成功的产品，也会有一个故事，其实，Purelog只是即兴之作，绝非预谋之作。 --> -##Purelog是给我自己用 +## Purelog是给我自己用 -###居然写八年博客了 +### 居然写八年博客了 我找到我有记录的文章，最早一篇是在2005-12-24 17:04:27，最初的乱七八糟，到后来写技术教程，再到后来写业界评论，一度给一些科技类网站写专栏。写博客的爆发期是在2010年左右的时候，起因是我在月光博客投了一篇稿子，寻段时间我基本上是一天一篇博客，起码一周也有三篇。 @@ -22,19 +22,19 @@ Excerpt: 所有成功的产品，都会有一个故事，对于一个没成功 那么，清掉没营养的，剩下的就是有营养的了么，我看未必，我觉得我博客中，真正有价值的，可能不超过5篇，还是有很多没有多大价值的文章，就比如说这篇。虽然我知道多一些原创的内容对博客的访问量有好处，但访问量真的那么重要吗，读者的价值更重要。网络上不需要太多的电子垃圾，我希望我能尽量地减少一些。 -###对博客系统的选择 +### 对博客系统的选择 最初我是用博客中国提供的博客平台，后来自己建独立博客，最初用z-blog，后来一直用Wordpress。Wordpres这个东西很强大，但因为太强大了，所以变得特别脆弱。Wordpress要照顾到所有人，所以就变得不能讨好所有人。我博客最高的时候不过2000独立IP，但Wordpress都顶不住，没有经过优化下，Wordpress几乎不堪一击。臃肿只不过是Wordpress众多问题中最突出的一个。 开始写博客希望有复杂的功能，什么相册啊，评论啊，什么功能都想住里加，后来觉得，我只需要专注写作，我需要的是简单地写文章，所以我选择了Markdown。但我需要一个配套的简单的博客系统，还有，要快速，足够的快。 -###Ghost梦想的破灭 +### Ghost梦想的破灭 我一直在期待Ghost，早前我也有过要自己用Node.js写一个博客系统让自己用的想法，但当我看到Ghost的宣传之后，和很多人一样，我也心动了。 直到Ghost发布，我表示我自己深深地失望了，一个非常漂亮的Markdown所见即所有编辑器，但它不是我想要的。我想要的，是用Mou写好文章，然后保存到Dropbox，博客被更新了。或者我把文章提交到Github，然后我的博客被更新了。是的，我不需要Markdown的在线编辑器，我真的不需要。 -##我发神经 +## 我发神经 我最初正在弄我的简历，然后我想我需要一个博客来放我的作品与文章，但之前的博客被停掉了，我又不想再上一个Wordpress，Ghost又无法轻松地导入我的文章。于是，我就犯二了，我要做一！个！博！客！！！ @@ -54,12 +54,12 @@ Excerpt: 所有成功的产品，都会有一个故事，对于一个没成功 所以说，自己会做某样东西真不好，我是要一个木匠，我会把家里的家具全部重新做一篇的，幸好我不是。 -##关于Purelog一些事 +## 关于Purelog一些事 -###端口13111 +### 端口13111 本来我想用端口是131031的，即是开发Purelog的那一天，但你知道，端口号只能在65535以内，所以我就选择了第二天，2013年11月1日，反正也没差几分钟了。 -###博客名称 +### 博客名称 Purelog其实是我另一个产品的名字，而且并不是博客，但那个产品还没做，所以就被我用上了。Pure + log，我希望它是一个纯粹的博客系统，只为写作。 \ No newline at end of file diff --git "a/purelog-cli/boilerplate/app/content/\345\246\202\344\275\225\351\205\215\347\275\256Purelog.md" "b/purelog-cli/boilerplate/app/content/\345\246\202\344\275\225\351\205\215\347\275\256Purelog.md" index 5e90963..b571cd0 100644 --- "a/purelog-cli/boilerplate/app/content/\345\246\202\344\275\225\351\205\215\347\275\256Purelog.md" +++ "b/purelog-cli/boilerplate/app/content/\345\246\202\344\275\225\351\205\215\347\275\256Purelog.md" @@ -14,7 +14,7 @@ Purelog是一个高度可配置的博客，除了插件之外，它还支持很 Purelog的配置采用JSON格式，一个标准的配置文件请参考[这里](https://gist.github.com/conis/7330792) -##blog +## blog `blog`键用于配置博客的基本信息，包含作者、博客标题等 @@ -30,7 +30,7 @@ Purelog的配置采用JSON格式，一个标准的配置文件请参考[这里]( * page_size - 文章分页大小 -##cache +## cache `cache`键负责缓存的设置（功能暂未实现），这里的缓存是直接缓存html页，如果缓存，则下次请求的时候直接返回已经渲染的html，不需要再经模块渲染，如果你使用了nginx反向代理，并且代理开启了缓存，则不需要设置这里的缓存 @@ -38,14 +38,14 @@ Purelog的配置采用JSON格式，一个标准的配置文件请参考[这里]( * article - 是否缓存文章页，默认为`true` -##optimize +## optimize `optimize`键负责优化相关的设置 * min_css - 是事最小化压缩css，默认为`true` * min_js - 是否最小化压缩js，默认为`true` -##routes +## routes `routes`负责处理路由规则，但优先级比插件中的路由要低，这就意味着，如果某个路由插件也处理了`/`这个路由，你的首页将会被这个插件接管。注意路由地址都要以`/`开始，`/make.html`是一个合法的路由，而`make.html`将会是404错误。 @@ -57,7 +57,7 @@ Purelog的配置采用JSON格式，一个标准的配置文件请参考[这里]( `article` - 文章页的路由，这里暂不支持多路由。默认为`/archive/:article.html` -##plugins +## plugins `plugins`是Purelog一个非常重要的配置项，`plugins`键下有四个子键，分别对应着Purelog四种不同类型的插件，除了`routes`可以是多选之外，其它的插件都只能使用一个。 @@ -65,25 +65,25 @@ Purelog的配置采用JSON格式，一个标准的配置文件请参考[这里]( 官方的插件配置，请参考文章最后。 -###theme +### theme `theme`负责主题插件的配置，如果你需要换主题，首先要用`npm install purelog-theme-name`，再将这里改为`purelog-theme-name`即可。 -###routes +### routes `routes`负责路由插件的配置，默认情况已经配置了`purelog-router-rss`这个插件，负责处理Purelog的rss输出。 -###reduce +### reduce `reduce`负责处理数据整理的插件，默认情况下，安装了`purelog-reduce-cache`，`purelog-reduce-cache`会将数据全部放在内存中，如果你不希望文章被缓存在内存中，你可以使用其它存储在数据中的插件。 -###storage +### storage `storage`是负责存取数据的插件，默认情况，安装了·purelog-storage-local·的插件，这个插件将会在本地文件夹中读取文章。官方还提供`purelog-storage-dropbox`和`purelog-storage-git`两个插件，用于读取dropbox与git的文章，这两个插件默认是已经安装的，你可以根据自行选择替换。 -##插件配置 +## 插件配置 请访问 [官方默认插件介绍及配置](http://purelog.org/archive/plugin-configure.html) diff --git "a/purelog-cli/boilerplate/app/content/\345\256\230\346\226\271\346\217\222\344\273\266\345\217\212\351\205\215\347\275\256\346\214\207\345\215\227.md" "b/purelog-cli/boilerplate/app/content/\345\256\230\346\226\271\346\217\222\344\273\266\345\217\212\351\205\215\347\275\256\346\214\207\345\215\227.md" index 88b4b5a..4b7f492 100644 --- "a/purelog-cli/boilerplate/app/content/\345\256\230\346\226\271\346\217\222\344\273\266\345\217\212\351\205\215\347\275\256\346\214\207\345\215\227.md" +++ "b/purelog-cli/boilerplate/app/content/\345\256\230\346\226\271\346\217\222\344\273\266\345\217\212\351\205\215\347\275\256\346\214\207\345\215\227.md" @@ -14,11 +14,11 @@ Purelog的插件安装十分简单，只需要在终端输入`npm install plugin 下面介绍几个官方的插件及配置： -##purelog-storage-local +## purelog-storage-local 这个获取用于获取指定目录下的markdown文件。 -###配置 +### 配置 * filter - 过滤文件的正则表达式，默认为`/\.((md)|(markdown))$/i`，即只获取扩展名为md和markdown的文件。 * content - 文章的存放目录，目前只支持相对目录，默认为`content`，也就说，默认情况，你的博客文章应该放在`安装目录/content`下 @@ -58,11 +58,11 @@ Purelog的插件安装十分简单，只需要在终端输入`npm install plugin } } -##purelog-storage-dropbox +## purelog-storage-dropbox 从dropbox共享链接中下载所有文件到本地，并提取所有的markdown文件。 -###配置 +### 配置 * `url` - dropbox的共享链接 * `content` - 等同于`purelog-storage-local`中的`content`，但这里建议使用其它名称，如`dropbox` @@ -70,22 +70,22 @@ Purelog的插件安装十分简单，只需要在终端输入`npm install plugin `purelog-storage-dropbox`插件依赖于`purelog-storage-local`，其它配置与`purelog-storage-local`的配置完全一样。 -##purelog-storage-git +## purelog-storage-git 从git中获取某个仓库的文件到本地，并提取分析所有的markdown文件。注意，`purelog-storage-git`依赖于`git`命令，所以，你必需在服务器上安装好git。 -###配置 +### 配置 * `url` - git的仓库地址 * `content` - git本地存放文件夹，不建议使用与`purelog-storage-local`相同的文件夹。 `purelog-storage-git`插件依赖于`purelog-storage-local`，其它配置与`purelog-storage-local`的配置完全一样。 -##purelog-router-rss +## purelog-router-rss 实现Purelog的RSS功能 -###配置 +### 配置 * `full` - 是否支持全文输出，默认为`true` * `limit` - 输出多少条文章，默认为20 @@ -107,7 +107,7 @@ Purelog的插件安装十分简单，只需要在终端输入`npm install plugin } ] -##purelog-theme-ghost +## purelog-theme-ghost 与Ghost默认主题一样的主题，此主题完全使用[Ghost](http://ghost.org)的代码，在此表示感谢。 @@ -115,7 +115,7 @@ Purelog的插件安装十分简单，只需要在终端输入`npm install plugin 无相关配置 -##purelog-reduce-cache +## purelog-reduce-cache 整理数据的插件，将数据保存在内存中 diff --git "a/purelog/content/Purelog\346\230\257\344\273\200\344\271\210.md" "b/purelog/content/Purelog\346\230\257\344\273\200\344\271\210.md" index 205f5c4..57388fe 100644 --- "a/purelog/content/Purelog\346\230\257\344\273\200\344\271\210.md" +++ "b/purelog/content/Purelog\346\230\257\344\273\200\344\271\210.md" @@ -10,7 +10,7 @@ Excerpt: Purelog是一个轻量快速的，完全基于Markdown的，可扩展 如果你憎恨Wordpress的臃肿与性能，如果你想专注于写作，如果你正在或者准备使用Markdown写作，如果希望将你的文章保存到Dropbox或者Gibhub，如果你想获取极高的响应速度，如果你是一个Node.js的开发者，那么你一定要尝试一下Purelog。 -##Purelog的特点 +## Purelog的特点 * 极速，Purelog在启动的时候，会将博客的文章读取内存，完全不需要再读取硬盘，所以响应非常快速 * 基于Markdown，Purelog基于文件式的Markdown，这就意味你只需要将Markdown文件保存到某个文件夹就可以了 @@ -19,7 +19,7 @@ Excerpt: Purelog是一个轻量快速的，完全基于Markdown的，可扩展 * 支持多主题 * 支持插件扩展 -##Purelog适合于哪些人群 +## Purelog适合于哪些人群 * 有自己的VPS或者云主机，如Appflog，总之，你需要Node.js的环境 * 有一定的动手能力，比如说能部署Node.js，会使用`npm install -g purelog` @@ -29,7 +29,7 @@ Excerpt: Purelog是一个轻量快速的，完全基于Markdown的，可扩展 如果你有两项匹配，我建议你可以尝试一下Purelog。 -##如何安装Purelog +## 如何安装Purelog Purelog的安装非常简单，首先要确保你安装了Node.js，然后在命令行按如下步骤： @@ -39,6 +39,6 @@ Purelog的安装非常简单，首先要确保你安装了Node.js，然后在命 只需要简单的三步，你的Purelog就能正常运行了，访问http://localhost:13111就可以访问你的博客了。但这时候Purelog还是默认配置，你需要修改一些简单的配置。[如何修改Purelog的配置](http://purelog.org/archive/configure.html) -##Github +## Github 作为一个开源系统，Github当然是必需要提供的了：[Purelog on Github](https://github.com/conis/purelog) \ No newline at end of file diff --git "a/purelog/content/Purelog\347\232\204\346\217\222\344\273\266\345\274\200\345\217\221\346\214\207\345\215\227.md" "b/purelog/content/Purelog\347\232\204\346\217\222\344\273\266\345\274\200\345\217\221\346\214\207\345\215\227.md" index fb9505e..ab0bc48 100644 --- "a/purelog/content/Purelog\347\232\204\346\217\222\344\273\266\345\274\200\345\217\221\346\214\207\345\215\227.md" +++ "b/purelog/content/Purelog\347\232\204\346\217\222\344\273\266\345\274\200\345\217\221\346\214\207\345\215\227.md" @@ -10,14 +10,14 @@ Excerpt: 介绍如何开发Purelog的插件，主要介绍Storage插件、Router 给Purelog开发插件是一件非常容易的事情，Purelog重度依赖插件，很多工作都需要插件来完成，如果你正在学习或者使用Node.js，那么请参与进来吧。 -##Purelog插件的类型 +## Purelog插件的类型 * Storage - 负责数据存取，例如扫描本地文件夹的Markdown文件或者从Dropbox中下载Markdown文件 * Reduce - 负责整理数据，从Storage中读取出来的数据是无序的，所以需要索引和排序。Storage将数据读取出来之后，就完全放弃所有数据，之后数据由Reduce接管。 * Router - 路由插件可以截获路由，然后自己做相应的处理，例如`purelog-router-rss`就会截获http://domain.com/rss/这个地址，并提供rss输出。 * Theme - 主题类插件，负责界面的呈现，可以由任何一种模板语言开发，如handlebars、jade等等。 -##程序接口 +## 程序接口 purelog接口可以提供所有的操作，purelog提供的接口如下： @@ -30,7 +30,7 @@ purelog接口可以提供所有的操作，purelog提供的接口如下： * `package` - Purelog的包信息，包括名称，版本等信息 -##统一接口 +## 统一接口 所有插件都需要提供下列这些接口，即实现`exports.xxx`。 @@ -46,11 +46,11 @@ purelog接口可以提供所有的操作，purelog提供的接口如下： * `register` - 用于注册插件的方法，该方法会提供两个参数，分别是`purelog`和`optons`，`purelog`提供整个Purelog可操作的方法，`options`则是读取`config.js`中相应的配置信息。 -##storage插件 +## storage插件 storage插件需要实现原始数据的读取及保存功能，实现key/value数据的保存功能。 -###fetch +### fetch 用于获取所有的文章，每获取一篇文章，会调用`iterator`，获取完成后，会调用`done` @@ -63,17 +63,17 @@ storage插件需要实现原始数据的读取及保存功能，实现key/value 其它的尝未实现，暂不介绍 -##reduce插件 +## reduce插件 -###initial +### initial 初始化数据，例如清空缓存 -###indexMaker +### indexMaker 重建文章的索引 -###getArticleContent +### getArticleContent /* 根据url，获取文章的内容 @@ -81,14 +81,14 @@ storage插件需要实现原始数据的读取及保存功能，实现key/value */ exports.getArticleContent = function(url) -###appendArticle +### appendArticle /* 添加文章 @param {Object} article - 文章的JSON对象 */ exports.appendArticle = function(article){ -###findArticle +### findArticle /* 查找获取文章 @@ -104,7 +104,7 @@ storage插件需要实现原始数据的读取及保存功能，实现key/value */ exports.findArticle = function(options) -###articleCount +### articleCount /* 返回文章的总数量 @param {undefined | String} tag - 如果指定标签，则返回该标签下的文章 @@ -112,7 +112,7 @@ storage插件需要实现原始数据的读取及保存功能，实现key/value */ exports.articleCount = function(tag) -###oneArticle +### oneArticle /* 获取一篇文章 @param {String} url - 文章的url @@ -121,7 +121,7 @@ storage插件需要实现原始数据的读取及保存功能，实现key/value exports.oneArticle = function(url, tag) -###findTag +### findTag /* 查找标签 @param {Object} options - 选项 @@ -134,8 +134,8 @@ storage插件需要实现原始数据的读取及保存功能，实现key/value */ exports.findTag = function(options) -##router插件 -###routes +## router插件 +### routes 返回要接管的路由列表，一个典型的路由如下： @@ -155,11 +155,11 @@ storage插件需要实现原始数据的读取及保存功能，实现key/value * `trigger` - 解发的方法，注意，这个触发的方法在router插件中，必需是公开的方法，即由exports实现的方法 -##theme插件 +## theme插件 theme将会有一篇文章专门讲，这里只说接口 -##render +## render /* @summary 渲染内容 @@ -169,7 +169,7 @@ theme将会有一篇文章专门讲，这里只说接口 */ exports.render = function(type, data) -##static +## static /* 有些时候可能需要进行路径转换 @summary 返回主题中的静态资源路径 diff --git "a/purelog/content/\345\205\263\344\272\216Purelog\347\232\204\346\225\205\344\272\213.md" "b/purelog/content/\345\205\263\344\272\216Purelog\347\232\204\346\225\205\344\272\213.md" index b0fcaec..7f9d8dc 100644 --- "a/purelog/content/\345\205\263\344\272\216Purelog\347\232\204\346\225\205\344\272\213.md" +++ "b/purelog/content/\345\205\263\344\272\216Purelog\347\232\204\346\225\205\344\272\213.md" @@ -8,9 +8,9 @@ Tags: 产品,故事, Node.js, Purelog Excerpt: 所有成功的产品，都会有一个故事，对于一个没成功的产品，也会有一个故事，其实，Purelog只是即兴之作，绝非预谋之作。 --> -##Purelog是给我自己用 +## Purelog是给我自己用 -###居然写八年博客了 +### 居然写八年博客了 我找到我有记录的文章，最早一篇是在2005-12-24 17:04:27，最初的乱七八糟，到后来写技术教程，再到后来写业界评论，一度给一些科技类网站写专栏。写博客的爆发期是在2010年左右的时候，起因是我在月光博客投了一篇稿子，寻段时间我基本上是一天一篇博客，起码一周也有三篇。 @@ -22,19 +22,19 @@ Excerpt: 所有成功的产品，都会有一个故事，对于一个没成功 那么，清掉没营养的，剩下的就是有营养的了么，我看未必，我觉得我博客中，真正有价值的，可能不超过5篇，还是有很多没有多大价值的文章，就比如说这篇。虽然我知道多一些原创的内容对博客的访问量有好处，但访问量真的那么重要吗，读者的价值更重要。网络上不需要太多的电子垃圾，我希望我能尽量地减少一些。 -###对博客系统的选择 +### 对博客系统的选择 最初我是用博客中国提供的博客平台，后来自己建独立博客，最初用z-blog，后来一直用Wordpress。Wordpres这个东西很强大，但因为太强大了，所以变得特别脆弱。Wordpress要照顾到所有人，所以就变得不能讨好所有人。我博客最高的时候不过2000独立IP，但Wordpress都顶不住，没有经过优化下，Wordpress几乎不堪一击。臃肿只不过是Wordpress众多问题中最突出的一个。 开始写博客希望有复杂的功能，什么相册啊，评论啊，什么功能都想住里加，后来觉得，我只需要专注写作，我需要的是简单地写文章，所以我选择了Markdown。但我需要一个配套的简单的博客系统，还有，要快速，足够的快。 -###Ghost梦想的破灭 +### Ghost梦想的破灭 我一直在期待Ghost，早前我也有过要自己用Node.js写一个博客系统让自己用的想法，但当我看到Ghost的宣传之后，和很多人一样，我也心动了。 直到Ghost发布，我表示我自己深深地失望了，一个非常漂亮的Markdown所见即所有编辑器，但它不是我想要的。我想要的，是用Mou写好文章，然后保存到Dropbox，博客被更新了。或者我把文章提交到Github，然后我的博客被更新了。是的，我不需要Markdown的在线编辑器，我真的不需要。 -##我发神经 +## 我发神经 我最初正在弄我的简历，然后我想我需要一个博客来放我的作品与文章，但之前的博客被停掉了，我又不想再上一个Wordpress，Ghost又无法轻松地导入我的文章。于是，我就犯二了，我要做一！个！博！客！！！ @@ -54,12 +54,12 @@ Excerpt: 所有成功的产品，都会有一个故事，对于一个没成功 所以说，自己会做某样东西真不好，我是要一个木匠，我会把家里的家具全部重新做一篇的，幸好我不是。 -##关于Purelog一些事 +## 关于Purelog一些事 -###端口13111 +### 端口13111 本来我想用端口是131031的，即是开发Purelog的那一天，但你知道，端口号只能在65535以内，所以我就选择了第二天，2013年11月1日，反正也没差几分钟了。 -###博客名称 +### 博客名称 Purelog其实是我另一个产品的名字，而且并不是博客，但那个产品还没做，所以就被我用上了。Pure + log，我希望它是一个纯粹的博客系统，只为写作。 \ No newline at end of file diff --git "a/purelog/content/\345\246\202\344\275\225\351\205\215\347\275\256Purelog.md" "b/purelog/content/\345\246\202\344\275\225\351\205\215\347\275\256Purelog.md" index ae8a239..c1226ff 100644 --- "a/purelog/content/\345\246\202\344\275\225\351\205\215\347\275\256Purelog.md" +++ "b/purelog/content/\345\246\202\344\275\225\351\205\215\347\275\256Purelog.md" @@ -14,7 +14,7 @@ Purelog是一个高度可配置的博客，除了插件之外，它还支持很 Purelog的配置采用JSON格式，一个标准的配置文件请参考[这里](https://gist.github.com/conis/7330792) -##blog +## blog `blog`键用于配置博客的基本信息，包含作者、博客标题等 @@ -30,7 +30,7 @@ Purelog的配置采用JSON格式，一个标准的配置文件请参考[这里]( * page_size - 文章分页大小 -##cache +## cache `cache`键负责缓存的设置（功能暂未实现），这里的缓存是直接缓存html页，如果缓存，则下次请求的时候直接返回已经渲染的html，不需要再经模块渲染，如果你使用了nginx反向代理，并且代理开启了缓存，则不需要设置这里的缓存 @@ -38,14 +38,14 @@ Purelog的配置采用JSON格式，一个标准的配置文件请参考[这里]( * article - 是否缓存文章页，默认为`true` -##optimize +## optimize `optimize`键负责优化相关的设置 * min_css - 是事最小化压缩css，默认为`true` * min_js - 是否最小化压缩js，默认为`true` -##routes +## routes `routes`负责处理路由规则，但优先级比插件中的路由要低，这就意味着，如果某个路由插件也处理了`/`这个路由，你的首页将会被这个插件接管。注意路由地址都要以`/`开始，`/make.html`是一个合法的路由，而`make.html`将会是404错误。 @@ -57,7 +57,7 @@ Purelog的配置采用JSON格式，一个标准的配置文件请参考[这里]( `article` - 文章页的路由，这里暂不支持多路由。默认为`/archive/:article.html` -##plugins +## plugins `plugins`是Purelog一个非常重要的配置项，`plugins`键下有四个子键，分别对应着Purelog四种不同类型的插件，除了`routes`可以是多选之外，其它的插件都只能使用一个。 @@ -65,25 +65,25 @@ Purelog的配置采用JSON格式，一个标准的配置文件请参考[这里]( 官方的插件配置，请参考文章最后。 -###theme +### theme `theme`负责主题插件的配置，如果你需要换主题，首先要用`npm install purelog-theme-name`，再将这里改为`purelog-theme-name`即可。 -###routes +### routes `routes`负责路由插件的配置，默认情况已经配置了`purelog-router-rss`这个插件，负责处理Purelog的rss输出。 -###reduce +### reduce `reduce`负责处理数据整理的插件，默认情况下，安装了`purelog-reduce-cache`，`purelog-reduce-cache`会将数据全部放在内存中，如果你不希望文章被缓存在内存中，你可以使用其它存储在数据中的插件。 -###storage +### storage `storage`是负责存取数据的插件，默认情况，安装了·purelog-storage-local·的插件，这个插件将会在本地文件夹中读取文章。官方还提供`purelog-storage-dropbox`和`purelog-storage-git`两个插件，用于读取dropbox与git的文章，这两个插件默认是已经安装的，你可以根据自行选择替换。 -##插件配置 +## 插件配置 请访问 [官方默认插件介绍及配置](http://purelog.org/archive/plugin-configure.html) diff --git "a/purelog/content/\345\256\230\346\226\271\346\217\222\344\273\266\345\217\212\351\205\215\347\275\256\346\214\207\345\215\227.md" "b/purelog/content/\345\256\230\346\226\271\346\217\222\344\273\266\345\217\212\351\205\215\347\275\256\346\214\207\345\215\227.md" index 88b4b5a..4b7f492 100644 --- "a/purelog/content/\345\256\230\346\226\271\346\217\222\344\273\266\345\217\212\351\205\215\347\275\256\346\214\207\345\215\227.md" +++ "b/purelog/content/\345\256\230\346\226\271\346\217\222\344\273\266\345\217\212\351\205\215\347\275\256\346\214\207\345\215\227.md" @@ -14,11 +14,11 @@ Purelog的插件安装十分简单，只需要在终端输入`npm install plugin 下面介绍几个官方的插件及配置： -##purelog-storage-local +## purelog-storage-local 这个获取用于获取指定目录下的markdown文件。 -###配置 +### 配置 * filter - 过滤文件的正则表达式，默认为`/\.((md)|(markdown))$/i`，即只获取扩展名为md和markdown的文件。 * content - 文章的存放目录，目前只支持相对目录，默认为`content`，也就说，默认情况，你的博客文章应该放在`安装目录/content`下 @@ -58,11 +58,11 @@ Purelog的插件安装十分简单，只需要在终端输入`npm install plugin } } -##purelog-storage-dropbox +## purelog-storage-dropbox 从dropbox共享链接中下载所有文件到本地，并提取所有的markdown文件。 -###配置 +### 配置 * `url` - dropbox的共享链接 * `content` - 等同于`purelog-storage-local`中的`content`，但这里建议使用其它名称，如`dropbox` @@ -70,22 +70,22 @@ Purelog的插件安装十分简单，只需要在终端输入`npm install plugin `purelog-storage-dropbox`插件依赖于`purelog-storage-local`，其它配置与`purelog-storage-local`的配置完全一样。 -##purelog-storage-git +## purelog-storage-git 从git中获取某个仓库的文件到本地，并提取分析所有的markdown文件。注意，`purelog-storage-git`依赖于`git`命令，所以，你必需在服务器上安装好git。 -###配置 +### 配置 * `url` - git的仓库地址 * `content` - git本地存放文件夹，不建议使用与`purelog-storage-local`相同的文件夹。 `purelog-storage-git`插件依赖于`purelog-storage-local`，其它配置与`purelog-storage-local`的配置完全一样。 -##purelog-router-rss +## purelog-router-rss 实现Purelog的RSS功能 -###配置 +### 配置 * `full` - 是否支持全文输出，默认为`true` * `limit` - 输出多少条文章，默认为20 @@ -107,7 +107,7 @@ Purelog的插件安装十分简单，只需要在终端输入`npm install plugin } ] -##purelog-theme-ghost +## purelog-theme-ghost 与Ghost默认主题一样的主题，此主题完全使用[Ghost](http://ghost.org)的代码，在此表示感谢。 @@ -115,7 +115,7 @@ Purelog的插件安装十分简单，只需要在终端输入`npm install plugin 无相关配置 -##purelog-reduce-cache +## purelog-reduce-cache 整理数据的插件，将数据保存在内存中 diff --git "a/purelog/content/\347\211\210\346\234\254\345\216\206\345\217\262.md" "b/purelog/content/\347\211\210\346\234\254\345\216\206\345\217\262.md" index 1667f8b..829a776 100644 --- "a/purelog/content/\347\211\210\346\234\254\345\216\206\345\217\262.md" +++ "b/purelog/content/\347\211\210\346\234\254\345\216\206\345\217\262.md" @@ -8,13 +8,13 @@ Tags: 介绍，指南 Excerpt: Purelog的版本升级历史 --> -##V0.1.0(Beta) +## V0.1.0(Beta) 全新的架构，Purelog分为四个主要部分，分别是Storage/Reduce/Router/Theme，同时也对应着这四个部分的插件。 Purelog只包含核心代码，其它功能都交给插件来做，像主题，存储，数据整理，数据获取，RSS等都由插件实现，Purelog自带有五个插件，分别实现不同的功能。 -###日志 +### 日志 * 全新的架构，分离主题、存储、数据整理为单独的插件 * 增加Tag功能 @@ -24,14 +24,14 @@ Purelog只包含核心代码，其它功能都交给插件来做，像主题， * 增加命令行部署功能，实现`purelog --init`可以部署项目 * 增强对markdown文件的分析功能，允许更多的配置，如日期格式和tags的分隔符 -##V0.0.1(Alpah) +## V0.0.1(Alpah) 这个版本完成的Purelog的基本功能，对应的[Git commit](https://github.com/conis/Purelog/tree/a5ca382b1df4c5d23fbbc76d2263516b9598bb3d) 功能非常简单，架构也很简单，只是为了实现功能，就是可以读取Markdown并生成一个博客。主文件共四个，再加上一个主题。 -###日志 +### 日志 * 实现主题功能，默认使用Ghost的主题 * 实现从Markdown中根据Meta提取文章信息的功能 diff --git a/purelog/purelog-router-redirect/README.md b/purelog/purelog-router-redirect/README.md index 1ebe846..05c56ab 100644 --- a/purelog/purelog-router-redirect/README.md +++ b/purelog/purelog-router-redirect/README.md @@ -1,8 +1,8 @@ -##purelog-router-redicrect +## purelog-router-redicrect 实现博客的301功能，适用于博客搬家后改地址，适用于Purelog -##配置 +## 配置 1. 打开配置文件`config.js` 2. 在routes键增加一个配置，你需要对正则表达式有一定的了解，才能进行配置。示例配置如下： diff --git a/purelog/purelog-storage-local/README.md b/purelog/purelog-storage-local/README.md index 7f00840..d5268eb 100644 --- a/purelog/purelog-storage-local/README.md +++ b/purelog/purelog-storage-local/README.md @@ -3,6 +3,6 @@ purelog-storage-local 从本地读取markdown文件的插件，适用于[Purelog](https://github.com/conis/Purelog)。 -#Usage +# Usage `npm install purelog-storage-local`