GithubのEdit Modeをながめてみた

みなさん、こんにちは、まーしーです。
なにかしらの条件下で話すような簡単な日常会話レベルの英会話なら何となく言ってることはわかる（間違うときもありますが）けど、こちらから伝えたい事がすっとでてこないもどかしさを感じる日々です。

さて、GithubのWikiを編集するときにEdit Modeがいくつかあるのですが、あまり見たことが無いものがあったので少し調べてみました。
使えるモードは以下の物があります。

• AsciiDoc
• Creole
• Markdown
• MediaWiki
• Org-mode
• Pod
• RDoc
• Textile
• reStructuredText

これらのEdit Modeは軽量マークアップ言語（lightweight markup language）と呼ばれているようです。

軽量マークアップ言語 - Wikipedia
http://ja.wikipedia.org/wiki/%E8%BB%BD%E9%87%8F%E3%83%9E%E3%83%BC%E3%82%AF%E3%82%A2%E3%83%83%E3%83%97%E8%A8%80%E8%AA%9E

それぞれの記法については、Wikiの編集ページでhelpを表示させる事ができるのでそれをみればOKですね。

AsciiDoc

サーバー関係とかでよく使われる記法なのでしょうか？？

AsciiDoc Home Page
http://www.methods.co.nz/asciidoc/  

ソースとか用に「----」で囲うとかすればよいみたいです。
改行は反映されないみたいですね。

Creole

初めて見た記法です。

WikiCreole: Creole 1.0
http://www.wikicreole.org/wiki/Creole1.0  

Wiki Creoleの文法
http://www.antenna.co.jp/xml/xmllist/WikiCreole-grammar.html  

書き方としては「=」で見出しとなったりとわかりやすそうです。
改行は明示的に「\\」を入れてあげる必要があります。

コードなんかは「{{{」「}}}」で囲ってあげるかんじですね。

Markdown

なんとなく一番構造的に書きやすいのはこのMarkdownじゃないでしょうか。
見出しは「#」の数で調整するとかわかりやすいですね。

Markdown - Wikipedia
http://ja.wikipedia.org/wiki/Markdown

改行を半角スペース2つでいれる、というのが慣れが必要そうですね。
codeを書く場合は「`code`」このようなかんじですね。

MediaWiki

Wikipediaとかで使われている記法ですね。

Help:目次 マークアップ - Wikipedia
http://ja.wikipedia.org/wiki/Help:%E7%9B%AE%E6%AC%A1_%E3%83%9E%E3%83%BC%E3%82%AF%E3%82%A2%E3%83%83%E3%83%97  

大体の要素は用意されているみたいですが、HTMLを直接書いたほうがはやいかもしれないです。。

Org-mode

このモードの時は特にボタンなどが表示されませんが。

org-mode - Wikipedia, the free encyclopedia
http://en.wikipedia.org/wiki/Org-mode  

Emacsとかで使われたりする物なのでしょうか。
ちょっといまいち分かりませんでした・・・

Pod

Podとあっても何かよくわかりませんでしたが、Plain Old Documentationの略みたいですね。

Plain Old Documentation - Wikipedia
http://ja.wikipedia.org/wiki/Plain_Old_Documentation  

「サンプルコードを含めるのが簡単である。」という特徴が挙げられていますが、HTMLタグを覚える少し手前くらいの書き方を覚えないといけなさそうな感じでしょうか。

RDoc

このRDocはRuby系のものみたいですね。

RDoc - Wikipedia, the free encyclopedia
http://en.wikipedia.org/wiki/RDoc  

Ruby Document format - Wikipedia, the free encyclopedia
http://en.wikipedia.org/wiki/Ruby_Document_format  

Ruby Document format - Wikipedia
http://ja.wikipedia.org/wiki/Ruby_Document_format

ソースコードや入れ子なんかはindent（半角スペース）で判定しているようです。
改行は自動で判定してくれないようです。

Textile

初めてつかってみてますが、このTextileがつかいやすい、という気もしています。

Textile (markup language) - Wikipedia, the free encyclopedia
http://en.wikipedia.org/wiki/Textile_(markup_language)  

見出しが「h1.」「h2.」というのは「#」と書くのに比べたら若干引っかかりますが。
「#」はリストに割り当てられているので仕方ないのでしょう。。。

reStructuredText

なんか書き方としてはそこまで指定が無いのかな。。。

reStructuredText - Wikipedia
http://ja.wikipedia.org/wiki/ReStructuredText  

Pythonが関係してるとかなんとか。。。
ちょっとまだ使い方まで把握できてないです。

ということで

個人的にはTextileが使いやすいきがします。
Markdownは改行を明示しないといけないのが少し気になりますが、慣れの問題というのもそこそこあるきがしますし、よく見る記法なのでもう少し使ってみようと思います。

色々なプログラム言語とかサーバー関係であるとか、Githubを使う人が使いそうなものが色々網羅されているようだ、というのが調べてみて分かりました。

普段は滅多に使わないものばかりですが、個人的にはGithubのWikiをつかうとしたらMarkdown、Textileあたりがメインになりそうです。
Creole、RDocとかはもう少し触ってみてもいいのかも？といった気がしました。

みなさんGithubのWikiを編集する際は何をお使いですか？？