はじめに

GitHubで使える軽量マークアップ言語としてはMarkdownだけでなくorg-modeも使えます.

Emacs使いの皆さまにおかれましてはGitHubでもorg記法で書いてることでしょう.

org記法のとおり書けば, おおよそ期待どおりレンダリングされます¹が,
GitHub独自のMarkdown記法があるので, それに対応したGitHub独自のorg記法のチートシートを作りました (一部だけ).

チートシート

基本的な書き方とフォーマットの構文

テキストのスタイル設定

スタイル	構文	例	出力
下付き文字	`_{}`	`これは_{下付き}テキストです`	これは_下付きテキストです
上付き文字	`^{}`	`これは^{上付き}テキストです`	これは^上付きテキストです

脚注

#+OPTIONS: f:t

脚注です[fn:1].

[fn:1] 参考資料
  
中略

レンダリング結果:

Markdownのように脚注は末尾につきません

アラート記法

#+BEGIN_QUOTE
[!NOTE]
コンテンツをざっと読む場合でも、ユーザーが知っておくべき有益な情報
#+END_QUOTE

#+BEGIN_QUOTE
[!TIP]
物事をより良く、あるいはより簡単に行うための有益なアドバイス
#+END_QUOTE

#+BEGIN_QUOTE
[!IMPORTANT]
目標を達成するためにユーザーが知っておくべき重要な情報
#+END_QUOTE

#+BEGIN_QUOTE
[!WARNING]
問題を回避するために、ユーザーの即時の注意が必要な緊急情報
#+END_QUOTE

#+BEGIN_QUOTE
[!CAUTION]
特定の行動のリスクや否定的な結果について助言する
#+END_QUOTE

レンダリング結果:

コードブロックの作成とハイライト

#+BEGIN_SRC ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
#+END_SRC

レンダリング結果:

ダイアグラムの作成

#+BEGIN_SRC mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
#+END_SRC

レンダリング結果:

数式の記述

インライン式

この文は ~$~ 区切り記号を使ってインラインで数学を表している:  $\sqrt{3x-1}+(1+x)^2$

レンダリング結果:

ブロック式

*コーシー・シュワルツの不等式*

#+BEGIN_SRC math
\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)
#+END_SRC

レンダリング結果:

対応してない？ (対応して欲しい) org記法

下線

_下線_

タスクリスト

- [x] 下線に対応する
- [ ] 脚注に対応する
- [ ] タスクリストに対応する

[ ] や [x] がレンダリングされません

レンダリング結果:

参考

なお,

によると, パーサーは以下を使ってるようです.

Tips: `BEGIN_` ~ `END_` ブロックをタイプするのは手間なので

キーバインドとしては, コメントでご紹介いただいた

で展開する, または

yasnippet などでスニペット化しておくと便利です.
以下の例では `m[TAB] や !a[TAB] と打てば, mermaidやアラート記法のブロックが展開されるようになります.

mermaidのスニペット例

# -*- mode: snippet -*-
# name: mermaid
# key: `m
# --
#+BEGIN_SRC mermaid
graph ${1:LR};
${2:A} --> ${3:B};
$0
#+END_SRC

アラート記法のスニペット例

# -*- mode: snippet -*-
# name: alert
# key: !a
# --
#+BEGIN_QUOTE
[!${1:NOTE}]
$0
#+END_QUOTE

https://github.com/novoid/github-orgmode-tests ↩