inkproject / ink

An elegant static blog generator

Introduction

InkPaper is a static blog generator developed in Golang. No dependencies, cross platform, easy to use, fast building times and an elegant theme.

Features

• YAML format configuration
• Markdown format articles
• No dependencies, cross platform
• Super fast build times
• Continuously improving theme and typography
• Multiple article authors support
• Archive and tag generation
• Real-time preview when saving
• Offline full-text keyword search
• $\LaTeX$ style math formula support (MathJax):

$$ \int_{-\infty}^\infty g(x) dx = \frac{1}{2\pi i} \oint_{\gamma} \frac{f(z)}{z-g(x)} dz $$

Quick Start

• Download & Extract Ink and run ink preview

  Tip：Linux/macOS, use ./ink preview

• Open http://localhost:8000 in your browser to preview

Website Configuration

Edit config.yml, use this format:

site:
    title: Website Title
    subtitle: Website Subtitle
    limit: Max Article Count Per Page
    theme: Website Theme Directory
    comment: Comment Plugin Variable (Default is disqus username)
    root: Website Root Path # Optional
    lang: Website Language # Support en, zh, ru, ja, de, pt-br, configurable in theme/lang.yml
    url: Website URL # For RSS generating
    link: Article Link Scheme # Default is {title}.html, Support {year}, {month}, {day}, {hour}, {minute}, {second}, {title} variables

authors:
    AuthorID: # Your author ID, used in article's author field
        name: Author Name
        intro: Author Motto
        avatar: Author Avatar Path

build:
    output: Build Output Directory # Optional, default is "public"
    port: Preview Port
    copy:
        - Copied Files When Build
    publish: |
        Excuted command when 'ink publish' is used

Blog Writing

Create a .md file in the source directory (Supports subdirectories). Use this format:

title: Article Title
date: Year-Month-Day Hour:Minute:Second #Created Time. Support timezone, such as " +0800"
update: Year-Month-Day Hour:Minute:Second #Updated Time, optional. Support timezone, such as " +0800"
author: AuthorID
cover: Article Cover Path # Optional
draft: false # Is draft or not, optional
top: false # Place article to top or not, optional
preview: Article Preview, Also use <!--more--> to split in body # Optional
tags: # Optional
    - Tag1
    - Tag2
type: post # Specify type is post or page, optional
hide: false # Hide article or not. Hidden atricles still can be accessed via URL, optional
toc: false # Show table of contents or not, optional
---

Markdown Format's Body

Publish

• Run ink publish in the blog directory to automatically build and publish
• Or run ink build to manually deploy generated public directory

Tips: When files changed, ink preview will automatically rebuild the blog. Refresh browser to update.

Customization

Modifying The Theme

The default theme is placed in the theme folder, run npm install and npm run build to rebuild in this folder.

page page.html (article list) and article.html (article), use variable with Golang Template syntax.

New Page

Created any .html file will be copied to source directory, could use all variables on site field in config.yml.

Define Custom Variables

InkPaper supports defining custom variables in pages, which must be placed under site.config in config.yaml, such as:

site:
    config:
        MyVar: "Hello World"

The variable can be referenced in the page by {{.Site.Config.MyVar}}.

Note

Although the field names in other parts of config.yaml are all lowercase, the name of the custom variable must be used correctly. Otherwises, such a variable:

site:
    config:
        MYVAR_aAa: "Hello World"

must be referenced in the page as {{.Site.Config.MYVAR_aAa}}.

Use Functions (Experimental)

InkPaper defines a minimal set of functions that can be used in HTML pages (except for .md source files), such as

{{ readFile "path/to/file" }}

This will read the content of the file path/to/file and include it in the page without any processing.

For file-related functions, when executed in the source directory, the file path is relative to the source directory; when executed in other directories, the file path is relative to the theme (such as theme).

See the source file funcs.go for a list of all functions.

Blog Migration (Beta)

Supports simple Jeklly/Hexo post convertions. Usage:

ink convert /path/_posts

Building from source

Local Build

1. Install Golang environment
2. Run git clone https://github.com/InkProject/ink && cd ink && go install to compile and install ink
3. Run ink preview $GOPATH/src/github.com/InkProject/ink/template to preview blog

Docker Build (Example)

1. Clone code git clone [email protected]:InkProject/ink.git
2. Build image docker build -t ink . in source directory
3. Run container docker run -p 8888:80 ink

Theme

• Dark (Official Theme): https://github.com/InkProject/ink-theme-dark
• Simple: https://github.com/myiq/ink-simple
• Story: https://github.com/akkuman/ink-theme-story
• Material2: https://github.com/w568w/InkMaterialTheme

Related Tutorials

• Automatically deploy your Ink blog to GitHub pages with Travis CI

License

CC Attribution-NonCommercial License 4.0

Reporting An Issue

https://github.com/InkProject/ink/issues

These blogs are driven by InkPaper

• https://imeoer.github.io/blog/
• http://blog.hyper.sh/
• http://wangxu.me/
• http://whzecomjm.com/
• http://www.shery.me/blog/

ink's Issues

感觉不错，特意来感谢一下！

看了下感觉挺好的，官网挺好看的。

之前用 jekyll 做博客那个默认主题不好看，然后随便看了一下第三方的 jekyll 主题也不咋样。
感觉纸小墨不错。
话说官网 http://www.chole.io/ 能放一个 DEMO 吗？
就是搭建出来之后默认样式长什么样子。

谢谢。

How to contribute?

For example, i want to add one option in config.yaml and add one template in theme folder,
i have already modified parser.go 's SiteConfig and just can't let my template condition judgement work.
articel.html

{{template "moe" .}}

_moe.html

{{if .Site.Moe}}
balabala
{{end}}

config.yml

site:
    ...
    moe: true

parser.go

type SiteConfig struct {
	...
	Moe      bool

if i run ink preview, the console said

template: article:148:33: executing "moe" at <.Site.Moe>: can't evaluate field Moe in type main.SiteConfig

Empty post will cause an run time error

关于theme设置

因为每次更改主题都需要更改配置文件中的site中的theme字段和build中的copy段，如果主题较多，挑选主题的时候，每次需要一个一个改，会比较麻烦。
希望更换主题的时候只需要更改一处就好。
可以考虑把

copy:
    - theme/css
    - theme/js
    - theme/favicon.ico
    - theme/robots.txt

这段直接放到主题里面。

关于添加自定义配置字段的需求

情景

目前使用多说评论系统，模板中需使用一个key来对文章做唯一映射。目前使用.Date勉强可用。但不好维护。

需求

希望能够在article中添加一个可以user-define的字段。我便可以自定义一个字段来储存文章的多说评论的key

Can not use symbolic link for source dir

My source dir is a symbolic link. when I do ./ink publish it can not see my .md files inside source dir

Footer content wont change when I edit about.me.html then rebuild?

Hi Folks,

I made the following change in the copyright section of the /source/about.me.html file then rebuilt the blog, but it's still showing the (c) symbol on the blog, despite the code looking like this in the /public/about.me.html file. Am I doing something wrong or is this an issue?

            <span class="copyright">
                {{.Site.Title}} <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank">CC-BY 4.0</a> 
                <script type="text/javascript">
                    document.write(new Date().getFullYear());
                </script>
            </span>

[Feature Request] 添加统计逻辑

描述

时兴的博客框架都会支持各种诸如谷歌统计之类的服务，会提高框架的可用性，希望 ink 也可以实现一个。

关于RSS全文输出

试了下订阅，发现只能输出到预览，请问有办法全文输出么？

raspberry compatibility

can not run on raspberry(raspbian).

似乎没法使用Markdown的注释？

喂猫是English……算了不管了我就用中文写好了

嘛，举个例子：

*等身的作业* [^HW]

[^HW]: 引用自《纪念伏尔泰逝世一百周年的演说》

等身的作业 ^HW

显示的时间能改成分钟或者小时么？

-41417秒前 （更新于-41417秒前）
目录页是这样，详细页也是这样。

Parsing Time Month Out of Range

When previewing or building blog with command of ./ink preview, the error of parsing time “2016-2-18 14:15:00 -0800”: month out of range appears.

The actual time written within the .md file

Could this happen because of the wrong time format I wrote?
I have tried with year of 2015 with month 2(February) but it still appears to have the same error of time month out of range.

Any year-month-day formatting, with month less than 10 does not work.

If the month value is greater than 10, for any year, there is no error.
Kind of confused by this strange problem but can’t really find any solution.
Much appreciated for helping.

Preview的时候出现红色错误提示

Parse config.yml failed, please specify a valid path

无法预览

为毛[TOC]不能用……

em……由于不太懂go……所以帮不上忙
上网翻了一下文档，发现有以下几个

简书
atom
google

但是……大多数依赖JS……

Preview list page without any format conversion

Preview list page without any format conversion.
This may not be a bug,but this is not an graceful show,can you solve this problem to be optimized yet?
source code：

func ParseArticleConfig(markdownPath string) (config *ArticleConfig, content string) {
    ·······
    // Parse preview splited by MORE_SPLIT
    previewAry := strings.SplitN(content, MORE_SPLIT, 2)
    if len(config.Preview) <= 0 && len(previewAry) > 1 {
        config.Preview = previewAry[0]
        content = strings.Replace(content, MORE_SPLIT, "", 1)
    }
    return config, content
}

请问 root: Website Root Path 为什么无效？

config.yml 中的 root: /blog
修改后生成无效呢？
生成的html 内没有加入root的参数
结果还是这样的

是我没明白怎么用还是怎么回事？
大神辛苦了~

没有适用于amr64的吗？

如题，没有适用于arm64的吗？无奈技术有限尝试自己编译以失败告终。

ink publish err

[root@weixin-6r7c4 blog]# ../ink publish
Building ink-blog-tool-en
Building ink-blog-tool
Copying source/images
Copying theme/bundle
Copying theme/favicon.png
Copying theme/robots.txt

Finished to build in public folder (12.534257ms)
fatal: Not a git repository (or any of the parent directories): .git
fatal: Not a git repository (or any of the parent directories): .git
fatal: Not a git repository (or any of the parent directories): .git

如何在默认主题添加Instantclick啊？

我实验了好几次都不行，点击后无法加载正常网页。
这是我用的代码：
`<script src="//huangwuwen.firadio.net/ink/bundle/instantclick.min.js?v=3.1.0" data-no-instant></script>

<script data-no-instant>InstantClick.init();</script>`

当source里有较多文件的时候，在util.go里的Copy*函数会报错open <path/to/filename>: too many open files

本来想自行解决，发现自己不会编译项目Orz

install error

github.com/InkProject/ink/serve.go:73: web.Put undefined (type ink.Web has no field or method Put)
github.com/InkProject/ink/serve.go:74: web.Delete undefined (type ink.Web has no field or method Delete)

看看有没有这样的问题，我今天安装出现这个问题了 ^_^

Pages as markdown files

why cant pages also be added as markdown files to unify the process instead of html pages

improvement on copying files

希望能添加这样的功能：在article中增加copy配置字段，生成html时将对应文件复制至html的相同目录下。这样可以方便管理本地资源，提供一个可以在同一个article里面把资源跟markdown放一起的管理方法。

我现在的目录结构是这样的：blog/source/{year}/{month}/{article.name}/，每篇文章我会建立一个目录，然后把md和本地图片什么的都放到这个目录里面。

we can see the passwd

http://XXX.com/..%2F..%2F..%2F..%2F..%2F..%2F..%2F..%2F..%2F..%2Fetc%2Fpasswd

root:x:0:0:root:/root:/bin/bash
...
...
...
ubuntu:x:1000:1000:Ubuntu:/home/ubuntu:/bin/bash

从 Jekyll 迁移的日期格式问题

post 的 metadata 这里，Jekyll 的 date 定义形式如 2015-04-12，没有时分秒字段，在使用 ink convert _post 迁移到 ink 后，无法渲染页面。报如下错误：

�[31;1mparsing time "2012-08-18" as "2006-01-02 15:04:05": cannot parse "" as "15"
[0m

手动添加时分秒字段如 22:17:16 可以解决问题，希望提供兼容功能。谢谢。:)

建议添加多说支持哦

现在添加duoshuo还要硬编码，disqus在国内访问好慢啊

Custom Link Format Support

支持文章置顶吗？

搜索功能

最近在移植主题到Ink，首页模板有{{template "search" .}}，_search.html模板没修改过，但是还是不能搜索。
searchWorker.js 和 index.json 都正常，问题出现在哪里呢？

link rquest

http://wangsiyi.net/index.html is powered by ink now

关于引用路径

由于目前生成的html中使用的引用全部都是绝对路径，导致页面只有在根目录下才能正常访问。执行替换"/为"./后（暴力替换为相对路径）才可以部分正常访问。

问是否能将所有本地引用路径改为相对路径？

The Tags page of default theme is useless if you have many tags

look here, http://wangxu.me/tag.html , it is hard to tell

I know it is a problem of theme, but it is not easy to make a new theme for me...

What I want -- I think a list of tags including count of a tag, and link to its own page is ok

disqus 应该怎样配置

我尝试了disqus的邮箱和用户名，都提示

Add `ink new` command

Add ink new command, create a new markdown file.

Disable disqus

我没有看到官方提供的关掉 disqus 的方法，如果注释掉的话会向 '.disqus.com' 发起个无用的请求并且被 503。

如果有跟我一样强迫症的朋友可以用注入方式解决 503 的问题

config.yml:
  ...
  disqus: '; return; '
  ...

手机上网站首页图片不能随长宽比固定缩放

引用的同一张图片，在手机上首页图片会变形，
如上图，
但是进入文章页后图片显示却很正常，

感觉有点影响美观，长宽比固定了更好看。

Support LaTeX Syntax

Solution: http://www.twtccw.com/post/2015/12/20/cmd.html
Prepare for next release, will add to plugin list

主站下载的 Windows 客户端，32 位和 64 位均未加 .exe 后缀

因此导致命令行下找不到命令

关于inkpaper的3个问题请教

你好，猫叔，开发和维护辛苦了。我这里有3个关于inkpaper的问题想请教一下。

1、可以自己把评论换成多说吗？

2、作为静态博客，评论的数据是存储在哪里的呢？

3、是不是现在由markdown转成html，还不支持代码高亮呢？（我试了下Objective-C，似乎是还没有代码高亮）。还有是不是还不支持markdown的大纲功能呢？（[TOC]）

Web UI Release

Support Russian lang

thanks @vorons to submit PR #37 for Russian lang support, will publish on next release.

主站打不开了？

什么情况

linux ink preview error

root@OpenWrt:/myblog/ink_linux_386# ./ink preview
./ink: line 1: syntax error: unexpected "("

Serve Server Support

Provide serve server for watch changes, search article, api and deploy.

RSS Feed Support

关于替换评论插件

你好，猫叔。

关于替换评论插件的问题想咨询下你。

我发现在生成的文章html最后，都有这一段代码：

    <script type="text/javascript">
        (function() {
            var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
            dsq.src = '//somebody.disqus.com/embed.js';
            (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
        })();
    </script>

要替换评论插件，是不是要删除所有文章html的这段代码呢？那么，我想咨询下：

1. 生成这段代码的 go 文件在哪里呢？（在build.go里好像没有）。
2. 如果我想用 多说 评论插件，是不是需要修改build代码，让程序自动在每个文章html加入调用这个插件的代码呢？
3. 如果需要加入代码，那能否提示一下代码该怎么写呢？

（抱歉，问题比较小白。打扰了。）

‘’ink publish‘’ doesn't work well with Windows

When I ran command ink publish in Windows, the excuted command which I had added to the config.yml didn't work.

support article category in Archive

Add category for each article and to group all articles by category instead of Year.

(also can anyone give me some advice so that I may implement this by myself. I'm currently reading relevant code and try to implement, but some advice may helps a lot.)

开源协议是什么？建议加上