jk-write

jk-write

This is auiliary tool to write post on Jekyll .

jk-write

これは静的WebページジェネレータJekyllにおいて 新たな投稿を行うための補助ツールです。 Jekyllにおける_postディレクトリにファイル生成をしたり、 その中身を参照することができます。 なおmotemen/ghqを強く参照して作られました。

Feature

fzf(もしくはpeco)と組み合わせて便利なコマンドを作ることができます。

fishでの実際のコードを下記に示します。

alias jkn="jk-write new"
function jkw -d "write jekyll post"
    eval "jk-write list -r | fzf --query (commandline)" | read -z select
    if not test -z $select
        eval "emacs (jk-write root)/(builtin string trim "$select")"
    end
    commandline -f repaint
end

DEMO

Usage

使い方を示します。

Prepare to use

jekyllにおいて_postの場所をフルパスで設定しておく必要があります。

$ export JK_WRITE_ROOT="/set/your/full/path/jekyll/_post"

Commands

list

_postの中身のファイルを表示します。

$ jk-write list
2016-03-19-init.md
2016-12-31-diary.md
2017-01-05-movies.md
...

new

_postに新たなファイルを生成します。必ずtitleを入力する必要があります。

$ jk-write new hoge # title を hoge としている。
Do you make new file?(2018-12-21-hoge.md)[y/n]: y # input y or n
new file: 2018-12-21-hoge.md

root

JK_WRITE_ROOTの値を表示します。

$ jk-write root
/set/your/full/path/jekyll/_post

Additional option

生成するファイルに予めテンプレートを書き込んでおきたい場合は $HOME/tmp.mdにそれを記述しておくとそれを検出し、 生成するさいにそのファイルのコピーを生成します。

$ cat ~/tmp.md
---
layout: default
title: taitoru
mode: post
---

<!more>

Install

$ go get shamisonn/jk-write

For developers

you can use make

$ make build
$ make install

Similar Project

上位互換のプログラムが公開されていました。

If happen some problem

Write issue.