Markdown備忘録
GitHubの書籍
最近、GitHubでつまづくことが多いです。
時間が持ってかれます。つらいです。
ここは一度、GitHubの書籍を読んでおかないとまずいなと思ったので、kindleでこの書籍を購入しました。
まだ第一章ですが、すでにいくつか気づかされております。
やっぱり、書籍として情報がまとまっていると飲み込みやすいですね。
GitHubのマスコットの名前が「octcat」だということが分って満足しています。
GFMって何?
GitHubでは、ユーザが文字入力するすべての機能にGitHub Flavored Markdown (GFM) という記法で記述できます。
Markdown記法の亜種でしょうか。下のサイトを見る感じだと、CとC++のような関係なのかな。通常のMarkdown記法にテーブルや打ち消し線のルールを加えたのがGFMという解釈でいいのかな。というか、テーブルは通常のMarkdown記法の一部だとばかり思ってました。はてなのMarkdownにもテーブルは実装されてますよね!
通常のMarkdown
そもそもMarkdownも怪しいので、ここはしっかりと備忘録を作っとかなあかんと思いやす。下の記事の、大事だなと思った部分だけ抜き出しておきます。
Markdownのそもそもの役目
もともとは手軽にプレーンテキスト形式で書かれたファイルからHTMLを生成するために作られたものです。
Markdownで補えない部分
Markdownのルールで使用できない部分については素直にHTMLタグを使用してください。
唯一、<div>、<table>、<pre>、<p>"などのブロックタグを使用するときにはルールがあります。
これらのタグで囲まれた前後は空行でなければなりません。更にこれらのタグは行頭に置かなければなりません。タグの前にスーペスやタブを記述 しないでください。
※< は<、>は>と書くことも知れたので、今回の収穫は大きい(笑)
コードを乗せる
コードブロックの開始に続いて言語名を記述することで、記述した言語に対応したシンタックスハイライトを使うことができます。 Github上でハイライトすることができる言語は以下のページに示されています。
打ち消し線
文字列を"~~"で囲むことで打ち消し線をつけることができます。
hoge~~bar~~
hogebar
タスクリスト
-(ハイフン)に続いて角括弧をつけることでチェックボックスを表示することができます。 角括弧の中には半角スペースを入れてください。また、角括弧の中にx(半角)を入れることでデフォルトでチェックを入れることができます。
- [x] hogehogehgoe - [ ] foofoo
- [x] hogehogehgoe
- [ ] foofoo
※ ↑はてなだと出来ない模様
今回はこれで以上です。