转载

简洁的静态博客构建工具 —— 纸小墨(InkPaper)

纸小墨简介

纸小墨(InkPaper)是一个GO语言编写的开源静态博客构建工具,可以快速搭建博客网站。它无依赖跨平台,配置简单构建快速,注重简洁易用与更优雅的排版。

简洁的静态博客构建工具 —— 纸小墨(InkPaper)

开始上手

  • 下载并解压纸小墨,运行命令 ink preview
  • 使用浏览器访问 http://localhost:8000 预览。

特性介绍

  • YAML格式的配置
  • Markdown格式的文章
  • 无依赖跨平台
  • 超快的构建速度
  • 不断改善的主题与排版
  • 多文章作者支持
  • 归档与标签自动生成
  • 保存时实时预览页面
  • 离线的全文关键字搜索

配置网站

编辑 config.yml ,使用如下格式:

site:     title: 网站标题     subtitle: 网站子标题     limit: 每页可显示的文章数目     theme: 网站主题目录     comment: 评论插件变量(默认为Disqus账户名)     root: 网站根路径 #可选     lang: 网站语言 #支持en, zh, ru, ja,可在theme/config.yml配置     url: 网站链接 #用于RSS生成     link: 文章链接形式 #默认为{title}.html,支持{year},{month},{day},{title}变量  authors:     作者ID:         name: 作者名称         intro: 作者简介         avatar: 作者头像路径  build:     port: 预览端口     copy:         - 构建时将会复制的目录/文件     publish: |         ink publish 命令将会执行的脚本

创建文章

source 目录中建立任意 .md 文件(可置于子文件夹),使用如下格式:

title: 文章标题 date: 年-月-日 时:分:秒 #创建时间,可加时区如" +0800" update: 年-月-日 时:分:秒 #更新时间,可选,可加时区如" +0800" author: 作者ID cover: 题图链接 #可选 draft: false #草稿,可选 top: false #置顶文章,可选 preview: 文章预览,也可在正文中使用<!--more-->分割 #可选 tags: #可选     - 标签1     - 标签2  ---  Markdown格式的正文

发布博客

  • 在博客目录下运行 ink publish 命令自动构建博客并发布。
  • 或运行 ink build 命令将生成的 public 目录下的内容手动部署。

Tips: 在使用 ink preview 命令时,编辑保存文件后,博客会自动重新构建并刷新浏览器页面。

定制支持

修改主题

默认主题在 theme 目录下,修改源代码后在该目录下运行 npm installwebpack 重新构建。

页面包含 page.html (文章列表)及 article.html (文章)等,所有页面均支持 GO语言HTML模板 语法,可引用变量。

添加页面

source 目录下创建的任意 .html 文件将被复制,这些文件中可引用 config.yml 中site字段下的所有变量。

博客迁移(Beta)

纸小墨提供简单的Jeklly/Hexo博客文章格式转换,使用命令:

ink convert /path/_posts

源码编译

本地运行

  1. 配置 GO 语言环境。
  2. 运行命令 go get github.com/InkProject/ink ,编译并获取ink。
  3. 运行命令 ink preview $GOPATH/src/github.com/InkProject/ink/template ,预览博客。

Docker构建(示例)

  1. Clone源码 git clone git@github.com:InkProject/ink.git
  2. 源码目录下构建镜像 docker build -t ink .
  3. 运行容器 docker run -p 8000:80 ink

三方主题

  • Pure: https://github.com/Xdatk/ink-pure
  • Werttin: https://github.com/Skimige/ink_Werttin

反馈贡献

纸小墨基于 CC Attribution-NonCommercial License 4.0 协议,目前为止它仍然是个非成熟的开源项目,非常欢迎任何人的任何贡献。如有问题可报告至 https://github.com/InkProject/ink/issues 。

更新历史

  • [2016-07-11] 修复诸多Issue与合并一些PR。
  • [2015-08-15] 一些Bug修复,新增RSS订阅支持,主题改善。
  • [2015-07-04] 数项Bug修复与主题改善,支持置顶,多语言,子模板。
  • [2015-06-04] 编译更多平台版本,增加标签与存档页。
  • [2015-03-01] Beta版本,基础功能完成。

更新计划

  • 排版深度优化
  • 纸小墨编辑器

正在使用

原文  http://www.inkpaper.io/blog/ink-blog-tool.html
正文到此结束
Loading...