資料を書く

資料の書き方

HTML5のプレゼンテーションツールが用意されているので、それに合わせて資料を書いてください。したがってHTMLを書くことになりますが、HTMLを書きたくない方のためにMarkdownで資料が書けるようになっています。

Markdownで資料を書く

基本的にはMarkdownそのものですが、スライドの区切りとして ---- が使えるようになっています。

例:

C言語プログラミングとは
=======================
C言語勉強会 第0回

akiym  
May 29, 2013

----

### プログラミング

- C言語
- D言語

----

### Hello, world!

    printf("Hello, world!\n");

Markdownで書いた資料は bin/gen.pl を使うことでHTMLに書き出すことができます。

% perl bin/gen.pl slide.md > slide.html

Tips

--output オプションを指定すると docs/01-HelloWorld/index.html が生成されます。

% perl bin/gen.pl docs/01-HelloWorld/index.md --output

約束

資料を書いたならば、Pull Requestをして2人以上のレビューを受けてからmasterにmergeしてください。
(owner権限を持っている場合は、branchを切ってPull Requestすれば良いです。それ以外の方はforkしてPull Requestしてください。)

• masterでPull Requestせず、branchを切ってPull Requestする
• gh-pagesに直接mergeしない
• commitする際にはエンコーディングが UTF-8 改行コードが LF になっていることを確認する
• Markdownで書かれた資料を修正する場合は、 .html ではなく .md を編集する
  • HTMLへ変換できない場合は .md の変更だけで良い

Windowsユーザーの方へ

Windowsでは改行コードが CRLF なので、commitする際には改行コードを LF に変換する必要があります。Gitには core.autocrlf を設定することでcommit時に CRLF を LF に自動的に変換してくれる機能があります。

% git config --global core.autocrlf true

merge後の手順

gh-pagesへ merge commit をcherry-pickします。

% git checkout gh-pages
% git cherry-pick -m 1 (commit)
% git push origin gh-pages

---

不明な点があれば @akiym, @kodam, @kumar8600 までどうぞ。