Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
196 lines (136 sloc) 4.67 KB

Build Status

FOW - Focus On Writing

Demo: http://zhangxiaoyang.me/

快速入门

第一步:使用npm安装fow并更新。

npm install fow -g

第二步:创建静态博客。

fow init myblog
cd myblog
fow build
fow serve

第三步:访问http://localhost:8090/

Fow简介

命令行

  • fow [i/init] [DIR_NAME] 创建博客
  • fow [n/new] [ARTICLE_ID] 创建一篇文章,ARTICLE_ID是CATEGORY_NAME/ARTICLE_NAME这样的格式,比如当前文章的ARTICLE_ID是fow/quickstart
  • fow [b/build] 构建静态资源,默认情况下只构建修改后的ARTICLE_ID,可以加--force参数强制构建所有
  • fow [s/serve] [PORT] 开启本地服务器,默认端口为8090,可以访问http://localhost:8090/预览博客
  • fow [h/help] 显示帮助信息

在任意fow目录的层次中,均可以使用fow命令(init命令除外)。 ARTICLE_ID说明:ARTICLE_ID是固定的,即目录名+斜线+文章名。

写文章

执行fow new ARTICLE_ID创建的文章,对应于drafts/categories/ARTICLE_ID.md文件。

可以使用GitHub Flavored Markdown写文章。

摘要

我是摘要

<!--more-->

继续写文章

<!--more-->前面的内容将被作为摘要,就目前而言,摘要与其它内容的不同之处仅仅是样式不同。

图片

图片默认放在文章所在目录的images文件夹内,示例![](xiyangyang.jpg)

公式

${\widehat{C_i}} = C_i + \Phi(i) - \Phi(i-1)$将会转换为以下公式。

${\widehat{C_i}} = C_i + \Phi(i) - \Phi(i-1)$

可以使用在线公式编辑器来辅助生成LaTeX代码。

代码

```python
    if __name__ == '__main__':
        print 'Fow!'
```

转换后的代码如下。

    if __name__ == '__main__':
        print 'Fow!'

元数据

元数据文件drafts/meta.yml是整个博客是索引,非常重要,示例如下。

- id: howto/helloworld
title: helloworld
category: howto
tags:
  - others
create_time: 2015-02-18 14:45:52
update_time: 2015-02-17 09:07:55

其中,id不建议修改,fow会自动管理。 建议修改title、category、tags、create_time、update_time,如下。

- id: howto/helloworld
title: 这是helloworld
category: 使用说明
tags:
  - fow
  - nodejs
  - 使用说明
create_time: 2015-02-18 14:45:52
update_time: 2015-02-17 09:07:55

博客配置

修改config.yml可以定制自己的博客,参数说明如下。

  • title 会显示在浏览器的标签页上
  • subtitle 会显示在个人头像的下方
  • meta html中相应的meta信息
  • profile avatar为个人头像,duoshuo为多说评论的id
  • navigation 定制设置导航条,比如新加了一个自定义页面
  • site 生成博客需要的一些基本信息,可以在此自定义博客的主题,博客的banner

自定义页面

如果想新加一个页面,比如about(关于)的页面,可以在drafts文件夹中添加文件about.md,然后设置config.ymlnavigation参数。

博客主题

可以在themes文件夹中添加自定义的主题,然后设置config.ymltheme参数。

默认主题为themes/default,修改自Oishi

博客插件

插件放置于plugins文件夹,目前有2个文件,plugins/header_plugin.ejsplugins/footer_plugin.ejs,分别进行html的头部注入和尾部注入。

贡献

期待你的贡献!

  • Fow 核心代码
  • Fow Custom 定制(包括布局、主题、插件)

感谢

Fow的开发离不开以下项目:

License

MIT