notes

notes repository

ノートの書き方

_postsディレクトリ以下にyyyy-mm-dd-title.mdという形式でファイル名を指定し、GitHub Flavored Markdown記法で文章を書きます。

例えば、2015-12-24-christmas-eve.mdとした場合、記事は2015年12月24日に作成されたものとして扱われ、URIにはchristmas-eveが使用されます。

GitHub Flavored Markdown記法については以下を参考にしてください。

• Basic writing and formatting syntax
• Organizing information with tables
• Creating and highlighting code blocks
• Autolinked references and URLs

ファイルの配置場所は_postsディレクトリ以下であれば直下であってもサブディレクトリ以下でも構いません。

公開せずに下書きとして見たい場合は_postsディレクトリの代わりに_draftsディレクトリ以下に配置します。

メタデータの指定

ファイルの先頭にメタデータを書くことができます。メタデータは---で区切った中に書きます。

---
author: John Doe
tags: christmas event
title: Christmas Eve
---
# Christmas Eve

...

スライドの書き方

レイアウトにデフォルトのnoteでなくslideを指定することでスライドとして表示することができます。

---
author: John Doe
layout: slide
tags: christmas event
title: Christmas Eve
---

ライブラリはremarkを使用しています。

また、同時にmermaidも使用しているのでフローチャートやダイアグラムを表示することができます。

<div class="mermaid">
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
</div>

とすることで図を表示できます。

ローカルマシンで確認する

Rubyとgithub-pagesというgemがインストールされていればローカルマシンで確認できます。

$ gem install github-pages
$ jekyll serve --drafts --watch

とすることでサーバを起動し、ファイルに変更があった場合にはリコンパイルを自動的に行います。

rbenvとruby-buildがインストールされている場合

rbenvとruby-buildがインストールされている場合は以下の通りにコマンドを実行するとローカルマシンで確認できるようになります。

$ rbenv install `cat .ruby-version`
$ gem install bundler rake
$ rake install
$ rake preview

1. .ruby-versionに書かれたバージョンのRubyをインストールする
2. BundlerとRakeをインストールする
3. github-pagesをBundlerでインストールする
4. サーバを起動する