LoginSignup
0
0

More than 1 year has passed since last update.

Markdwon / reStructuredText / Sphinx でよく使う記法

Last updated at Posted at 2023-02-06

この記事は、執筆者自身が使っているがすぐに忘れてしまうMarkdownなどの記法をメモしておくものです。(執筆中)
ここに書かれている記法が全ての環境で動作するものではなく、特定の環境でのみ動作する場合があります。

Markdown

主に、Jupyter Book で使用する MyST Markdown について書いています。

リンク

[リンクタイトル](URL)

キャプションとリファレンス

```{code-block}
---
name: sample_table
caption: XXXが持つ機能
---

図: XXXが持つ機能
上記{numref}`sample_table`

ページ間

(content:references:SECTION_NAME)=
# タイトル
[このタイトル](content:references:SECTION_NAME)

注釈

文章内に[^ref_NOTE1] 

^ref_NOTE1]: URLなどの注釈

定義リスト

Term 1
: Definition

Term 2
: Definition

備考

```{note}
本文

画像

![ALTテキスト](画像PATH)

タイトル付きは以下

![ALTテキスト](画像PATH "タイトル文字列")
0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0