| 1 | # BLOGO (轻量级博客生成工具)
|
| 2 |
|
| 3 | ## 目录
|
| 4 |
|
| 5 | * [功能](#功能)
|
| 6 | * [下载及安装](#下载及安装)
|
| 7 | * [使用](#使用)
|
| 8 | * [命令集](#命令集)
|
| 9 | * [特殊标记](#特殊标记)
|
| 10 | * [开发数据](#开发数据)
|
| 11 | * [TODO](#TODO)
|
| 12 | * [Bugs Report](#Bugs Report)
|
| 13 | * [授权协议](#授权协议)
|
| 14 |
|
| 15 | ## 功能
|
| 16 | 1. 快速创建博客，并使用MarkDown写文章
|
| 17 | 2. 自定义主题(目前仅支持Jade)
|
| 18 | 3. 一条命令同步到博客目的地(目前仅支持git)
|
| 19 | 4. 拥有专门的文章demo生成工具，方便在文章中插入示例
|
| 20 |
|
| 21 | ## 下载及安装
|
| 22 | 1. npm install blogo -g
|
| 23 |
|
| 24 | ## 使用
|
| 25 | 1. blogo init && blogo start
|
| 26 |
|
| 27 | ## 命令集
|
| 28 | 1. blogo init (dirname) || blogo i
|
| 29 |
|
| 30 | 创建博客
|
| 31 | 2. blogo new (articleName) || blogo n
|
| 32 |
|
| 33 | 创建一篇新文章
|
| 34 |
|
| 35 | blogo new -s
|
| 36 |
|
| 37 | 创建一篇新文章并且开启服务
|
| 38 | 3. blogo sample (sampleName)
|
| 39 |
|
| 40 | 创建一个新示例
|
| 41 | 4. blogo start || blogo s
|
| 42 |
|
| 43 | 创建一个本地web服务用来预览博客
|
| 44 | 5. blogo deploy || blogo d
|
| 45 |
|
| 46 | 提交博客
|
| 47 | 6. blogo generate || blogo g
|
| 48 |
|
| 49 | 手动编译md到blog
|
| 50 | 7. blogo remove (articleName) || blogo r
|
| 51 |
|
| 52 | 删除一篇文章
|
| 53 |
|
| 54 | ## 特殊标记
|
| 55 | {-demo(demoName)-}
|
| 56 |
|
| 57 | 在MarkDown中使用此标记用于在当前位置插入创建好的demo示例
|
| 58 |
|
| 59 | ## 开发数据
|
| 60 | ```
|
| 61 | {
|
| 62 | "post":{
|
| 63 | "articles":[{
|
| 64 | "title":"article name",
|
| 65 | "date":"create time",
|
| 66 | "year":"create year",
|
| 67 | "month":"create month",
|
| 68 | "day":"create day",
|
| 69 | "time":"create time without date info",
|
| 70 | "desc":"article description",
|
| 71 | "html":"article detail html"
|
| 72 | },...],
|
| 73 | "tags":{
|
| 74 | "tagName":["articles" like post.articles]
|
| 75 | },
|
| 76 | "time":{
|
| 77 | "year":{
|
| 78 | "list":["articles" like post.articles],
|
| 79 | "month":{
|
| 80 | "list":["articles" like post.articles],
|
| 81 | "day":{
|
| 82 | "list":["articles" like post.articles],
|
| 83 | "articlesName":post.articles
|
| 84 | }
|
| 85 | }
|
| 86 | }
|
| 87 | }
|
| 88 | //article数据仅存在于article页面
|
| 89 | "article":{
|
| 90 | "title":"article name",
|
| 91 | "date":"create time",
|
| 92 | "year":"create year",
|
| 93 | "month":"create month",
|
| 94 | "day":"create day",
|
| 95 | "time":"create time without date info",
|
| 96 | "desc":"article description",
|
| 97 | "html":"article detail html"
|
| 98 | }
|
| 99 | },
|
| 100 | "config":{
|
| 101 | "resourceUrl":"your blog url + /resource"
|
| 102 | "social":{
|
| 103 | "twitter":"",
|
| 104 | "github":"",
|
| 105 | ...
|
| 106 | },
|
| 107 | "email":"xx@xx.xx",
|
| 108 | "author":"xx",
|
| 109 | "blogName":"blog title",
|
| 110 | "disqusName":"xx"
|
| 111 | }
|
| 112 | }
|
| 113 | ```
|
| 114 |
|
| 115 | ## Bugs Report
|
| 116 | https://github.com/kevin14/blogo/issues
|
| 117 |
|
| 118 | ## TODO
|
| 119 | 1. 增加对于其他模版引擎的支持
|
| 120 | 2. 增加其他repo的支持
|
| 121 |
|
| 122 | ## 授权协议
|
| 123 | Released under the MIT, BSD, and GPL Licenses |
| \ | No newline at end of file |