Markdown#
Syntax#
Basis#
基本的な文法は,ネットを見るべし
Alerts#
少し前に新しく追加されたアラート機能
注釈
こんなやつ
Extentions#
sphinx-design
による拡張機能
Links#
参照リンクは,[text](URL)
のフォーマットである.
Tip
別タブで開かせたい場合,{:target=“_blank”} を末尾につければ良い
[text](URL){:target="_blank"}
リンクを作成する場合,2種類のパターンが考えられる.
ドキュメント間の参照 内部で参照する場合は,URLではなくファイルのパスとなる.
root page にリンクしたい場合は以下でできる.# [text](file name) [root page](../index.rst)
内部のセクション(見出し)まで指定することも可能.
セクションは,#section-name
である.
すべて小文字 + 空白はハイフンに置き換える.# [text](file name + section) [root page](../index.rst#sphinx)
外部への参照 外部リンクは,
https://
といったURLを指定する.
example にリンクしたい場合は以下でできる.# [text](URL) [root page](https://example.com)
GitHubのリンク#
GitHubのリンクの場合,[text](URL)
の text も URL とすると
KobeKosenRobotics/Wiki と表現可能
NewLine#
改行は2種類ある
文末尾に半角スペースを2つ入れる
文末尾に HTML の改行タグ
を入れる