メニュー
Sphinx ドキュメントの MyST Markdown 執筆支援スキル(ディレクティブ・ロール・相互参照・数式・sphinx-design)。extensions に myst_parser があるプロジェクトで docs/ 配下の .md を編集・作成するときや、MyST 記法について質問されたときに使用する。
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
SOC 職業分類に基づく
| name | myst-authoring |
| description | Sphinx ドキュメントの MyST Markdown 執筆支援スキル(ディレクティブ・ロール・相互参照・数式・sphinx-design)。extensions に myst_parser があるプロジェクトで docs/ 配下の .md を編集・作成するときや、MyST 記法について質問されたときに使用する。 |
| license | MIT |
| allowed-tools | Read, Edit, WebFetch |
docs/ 配下の .md ファイルを編集または作成する ANDdocs/conf.py の extensions に myst_parser が含まれる場合または以下:
```{note}
これは note ディレクティブです。
```
```{warning}
警告メッセージ。
```
```{tip}
ヒント。
```
```{code-block} python
def hello():
return "world"
```
```{toctree}
:maxdepth: 2
:caption: Contents
intro
guide/index
```
```{include} fragment.md
```
```{figure} image.png
:alt: 画像の説明
:width: 400px
キャプション。
```
```{table} 表のキャプション
:widths: auto
| A | B |
|---|---|
| 1 | 2 |
```
```{math}
e^{i\pi} + 1 = 0
```
colon_fence 拡張が有効な場合は :::{note} 形式でも同等に動作する。
内部参照: {ref}`my-label`
ドキュメント参照: {doc}`./other-page`
引用: {cite}`bibkey`
ダウンロード: {download}`./file.zip`
キーボード: {kbd}`Ctrl+C`
ファイル名: {file}`/path/to/file`
(my-label)=
## セクション
参照する側: [](my-label) または {ref}`my-label`
タイトル付き参照: {ref}`セクションへ <my-label>`
インライン: $E = mc^2$
ディスプレイ: $$\int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2}$$
LaTeX 環境 (amsmath 拡張):
```{math}
\begin{align}
a &= b \\
c &= d
\end{align}
```
```{card} カードタイトル
カード本文。
```
```{grid} 1 2 2 3
:::{grid-item-card} カード 1
:::
:::{grid-item-card} カード 2
:::
```
```{tab-set}
:::{tab-item} タブ 1
内容 1
:::
:::{tab-item} タブ 2
内容 2
:::
```
```{dropdown} クリックで開く
隠された内容。
```
::: 形式の混在){ref}foo ではなく {ref}`foo`).md 不要)公式ドキュメントから最新の記法を WebFetch で取得可能:
drillan/sphinx-oceanid の mermaid-diagram スキルへ委譲sphinx-build (執筆後のビルド確認)、sphinx-config (新拡張追加時)sphinx-revealjs のスライドを MyST で書くための記法ルール(見出しレベルによるスライド分割、list-table、2 カラムレイアウト等)。extensions に sphinx_revealjs があるプロジェクトで docs/ 配下の .md を編集・作成するときに使用する。汎用 MyST 記法は myst-authoring が担当。
sphinx-revealjs の conf.py 設定(プラグイン・コードハイライト・テーマ・スライド寸法・表の中央寄せ・Mermaid 統合)の知識を提供するスキル。sphinx-revealjs プロジェクトでスライドの見た目や挙動を変更・修正するときに使用する。conf.py 編集の実行は sphinx-config に委譲する。
sphinx-revealjs によるスライド専用プロジェクトを初期化するスキル。docs/ が未作成のプロジェクトで発表スライドの新規作成を求められたときに使用する。依存追加・MyST テンプレート生成・テーマ選定・Makefile 整備までを行う。
既存の reStructuredText 製 Sphinx ドキュメントを rst-to-myst で MyST Markdown へ移行するスキル。実質的な RST コンテンツを持つプロジェクトの移行を求められたときに使用する(sphinx-quickstart の雛形だけの場合は対象外)。変換結果を検証してから元ファイルを削除する。
Sphinx ドキュメント・スライドを Makefile 経由でビルドするスキル(HTML・latexpdfja・EPUB・linkcheck・livehtml・revealjs)。ドキュメントやスライドのビルド・プレビュー・開発サーバー起動・リンクチェックを求められたときに使用する。パッケージマネージャ検出とビルドエラーの解釈は本文参照。
docs/conf.py を既存設定を保ちながら安全に更新するスキル。Sphinx 拡張の追加・削除、テーマ、プロジェクトメタデータなど conf.py の変更を求められたときに使用する。