2022-10-08

開発ノートをできるだけ簡単に残しかつ公開する方法を模索していて、そのテストの一つとして Github Pages を試す。

欲しいのは、

  • vim でがしがし書けること: md を vim で書くのみ
  • プレビューでき、ライブリロードが効くこと: Makefile を作った
  • 即時公開ができること: github への push で可能
  • 画像の添付が楽なこと: github でコピペ
  • 検索が効くこと

で最後以外はぱっと試しで確認ができた。

テスト画像の添付

image

jekyll

install

$ asdf install ruby 2.7.2
$ asdf local ruby 2.7.2
$ gem install jekyll bundler
$ jekyll new [project_name]
$ cd project_name
$ bundle install
$ bundle exec jekyll serve --livereload

settings

マークダウンについて

By default, Jekyll uses the GitHub Flavored Markdown (GFM) processor for Kramdown.

see. https://jekyllrb.com/docs/configuration/markdown/#kramdown

困りごと

  • 生で記述するリンクが有効にならない。これはなんとかならないかな、めんどい。
    • kramdonw の場合、 <> でくくるとリンクになる
    • commonmark の場合、 extensions に autolink を入れると使えるようになる
  • 目次をつけたい
  • この方向で進めてよいか不安だ

参考