目次
このページでは,
- org-modeの基本的な文法一覧
- ページ内リンク
- [注釈] (#注釈)
- 折り畳み
- コメントアウト
の書き方についてまとめる.
org-modeの基本的な文法一覧
文法一覧表
よく使用する文法を以下の表にまとめた.
orgの記法 | |
---|---|
斜体 | /斜体/ |
太字 | *太字* |
下線 | _下線_ |
+打ち消し+ |
|
コマンド | =code= |
文章タイトル | #+TITLE: TITLE |
見出し | * 見出し |
番号つき見出し | 1. 1st |
箇条書き | - 1st |
定義リスト | DEF :: Something |
リンク | [[表示する文章][http://---]] |
水平線 | ------ |
脚注 | [fn:: インライン脚注] |
コメント | # コメント |
ページ内リンク
例えば,
のようにページ内を移動する方法を紹介する.
[表示する文章](#飛びたい見出しのタイトル)
基本的にはこのように書くと目的の見出しに飛ぶことができる.
...はずだった.
まれに飛ぶことができない場合がある.その例と対処法を以下にまとめる.
英字の大文字を使っている場合
目次で大文字を使っている場合は全て小文字にすると上手くいく.
[大文字ABCは小文字abcで書く](#大文字abcは小文字abcで書く)
空白を使っている場合
半角空白を使っている場合は空白の部分をハイフン-で置き換える
[空白 を 使っている時](#空白_を_使っている時)
全角空白を使っている場合は空白の部分を省略
[空白 を 使っている時](#空白を使っている時)
アンダーバー_とハイフン-以外の記号を使っている場合
半角記号!@#$%^&*()+|~=`[]{};':",./<>?は省略する
[半角記号!@#$%^&*()+|~=`[]{};':",./<>?は省略](#半角記号は省略)
全角の場合も同様.
上記を考えずにリンクを貼る技
上にいろいろと制約を書いたが,これを気にせずリンクを貼る方法があった.
見出しを作成すると画面右側に目次が表示されるようになっている.
そこをクリックするとページ内リンクと同じ動作をするが,飛んだ先でURLを確認すると上記のルールに沿った書き方で表示されている.
たとえば,右の「目次」をクリックして目次まで飛んだ際,
「https://qiita.com/midoriyanagi/items/a4f6bc82488b25ffd48e#目次」
というURLになる.この後半の「#」以下をページ内リンクの書き方に沿って記載することで,何も考えず脳死でリンクを貼ることができる.
非常に便利.最高.上のやつ書かんでも良かったまである.
注釈
言葉の説明などをしたい場合に使う.例えば
のようになる.
これは以下のように表記する.
注釈部分:注釈1[^1]
説明部分:[^1]: 注釈1の説明の部分はここ
折り畳み
例えば,
折り畳みの例
折り畳んだ文章がここに出るよのように文章を隠しておき整理することができる.書き方は以下の通り.
<details><summary>折り畳みの例</summary>
折り畳んだ文章がここに出るよ
</details>
コメントアウト
コメントアウトする場合はHTMLのコメントアウトの方法を使うらしい.書き方は以下の通り.
<!-- (コメントアウトしたい内容) -->
まとめ
今回は,Qiitaをorg-modeで書く場合に使う文法についてまとめた.(どうやらマークダウン方式の書き方が使えるようになったらしい.)
参考
以下のサイトを参考にした.
- source ~/prog/github/grad_members_20f/members/miyanagi/post/qiita_grammer.org