# Markdown

## Syntax
### Basis
基本的な文法は，ネットを見るべし
- [Qiita マークダウン記法 一覧表・チートシート](https://qiita.com/kamorits/items/6f342da395ad57468ae3)
- [Markdown記法 サンプル集](https://qiita.com/tbpgr/items/989c6badefff69377da7)
- [Markdown記法 チートシート](https://qiita.com/Qiita/items/c686397e4a0f4f11683d)
- [HTMLタグとの関係](https://toach.biz/blog/markdown-cheatsheet/)
- [これ見ときゃどうにかなる](https://study-sphinx.readthedocs.io/ja/latest/restruct/restruct.html)

### Alerts
少し前に新しく追加されたアラート機能
- [GitHub.com の Markdown でアラート記法が増えた話](https://qiita.com/Yarakashi_Kikohshi/items/e6802e08921388d8c6e9)
- [警告ディレクティブ(実際の表示に近い)](https://study-sphinx.readthedocs.io/ja/latest/restruct/restruct-warning.html)

```{note}
こんなやつ
```

### Extentions
`sphinx-design` による拡張機能
- [グリッドレイアウト](https://sphinx-design.readthedocs.io/en/latest/grids.html#grids)

    ::::{grid} 2
    :outline:

    :::{grid-item}
    A
    :::
    :::{grid-item}
    B
    :::
    ::::

- [カード](https://sphinx-design.readthedocs.io/en/latest/cards.html#cards)
    :::{card} Card Title
    Header
    ^^^
    Card content
    +++
    Footer
    :::

- [ドロップダウン](https://sphinx-design.readthedocs.io/en/latest/dropdowns.html#dropdowns)
    :::{dropdown} Dropdown title
    Dropdown content
    :::

- [タブ](https://sphinx-design.readthedocs.io/en/latest/tabs.html#tabs)
    ::::{tab-set}

    :::{tab-item} Label1
    Hello World
    :::

    :::{tab-item} Label2
    Hei!
    :::

    ::::

- [バッチ](https://sphinx-design.readthedocs.io/en/latest/badges_buttons.html#badges)
    
    {bdg-warning}`warning`

- [ボタン](https://sphinx-design.readthedocs.io/en/latest/badges_buttons.html#buttons)
    ```{button-link} https://example.com
    :color: primary
    :shadow:
    押すなよ？？
    ```

- [{octicon}`megaphone` アイコン](https://sphinx-design.readthedocs.io/en/latest/badges_buttons.html#octicon-icons)


### Links
{octicon}`link` 参照リンクは，`[text](URL)` のフォーマットである．

```{tip}
別タブで開かせたい場合，{:target="_blank"} を末尾につければ良い
`[text](URL){:target="_blank"}`
```

リンクを作成する場合，2種類のパターンが考えられる．
- ドキュメント間の参照
    内部で参照する場合は，URLではなく**ファイルのパス**となる．  
    [root page](../index.rst) にリンクしたい場合は以下でできる．  
    ```txt
    # [text](file name)
    [root page](../index.rst)
    ```

    内部のセクション（見出し）まで指定することも可能．  
    セクションは，`#section-name`である．  
    すべて小文字 + 空白はハイフンに置き換える.　
    ```txt
    # [text](file name + section)
    [root page](../index.rst#sphinx)
    ```

- 外部への参照
    {octicon}`link-external` 外部リンクは，`https://` といったURLを指定する．  
    [example](https://example.com) にリンクしたい場合は以下でできる．  

    ```txt
    # [text](URL)
    [root page](https://example.com)
    ```

##### GitHubのリンク
GitHubのリンクの場合，`[text](URL)` の text も URL とすると   
[https://github.com/KobeKosenRobotics/Wiki](https://github.com/KobeKosenRobotics/Wiki) と表現可能


### NewLine
改行は2種類ある
- 文末尾に半角スペースを2つ入れる
- 文末尾に HTML の改行タグ <br> を入れる