本ドキュメントでは、Shiroiブログシステムがサポートするすべての Markdown フォーマットを紹介しています。各機能にはコードと表示結果の2つのパートが含まれています。
一、基本テキストフォーマット
太字
太字テキスト と もう一つの太字
斜体
斜体テキスト と もう一つの斜体
太字斜体
太字斜体テキスト
取り消し線(GFM)
取り消し線テキスト
インラインコード
これは インラインコード の例です
二、Shiroi カスタムインライン構文
スポイラー/隠しテキスト
マウスホバーで内容が表示されます。
これは スポイラー内容、マウスホバーで表示 を含むテキストです。
ハイライトマーク(Mark)
これは ハイライトされた テキストです。
挿入テキスト/下線(Insert)
これは 挿入されたテキスト です。
ソーシャルプラットフォーム Mention
GitHub(GH)、Twitter(TW)、Telegram(TG)の3つのプラットフォームに対応しています。
三、見出し(H1 - H6)
見出しは自動的にアンカーリンクが生成され、日本語文字の slug にも対応しています。
(見出しの表示結果は本ドキュメントの各セクションをご覧ください)
四、リスト
順序なしリスト
- 第一項目
- ネスト 1.1
- ネスト 1.2
- 第二項目
- 第三項目
順序付きリスト
- 第一ステップ
- 第二ステップ
- サブステップ 2.1
- サブステップ 2.2
- サブステップ 2.2.1
- 第三ステップ
GFMタスクリスト
- 未完了のタスク
- 完了済みのタスク
- もう一つの TODO 項目
五、リンクと画像
通常のリンク
自動リンク
画像
自然風景の写真
六、引用
通常の引用
これは通常の引用テキストです。
ネストされた引用もサポートされています。
GFM Alerts(GitHub スタイルの警告ボックス)
注意:隣接する複数の Alert の間には <div /> で区切る必要があります。そうしないと1つの引用ブロックに統合されてしまいます。
[!NOTE] これは注意情報です。ユーザーが知っておくべき補足説明に使用します。
Tipこれはヒント情報です。より良い操作方法を提案します。
Importantこれは重要情報です。目標達成のためにユーザーが知る必要があります。
Warningこれは警告情報です。問題を回避するためにユーザーの即座の注意が必要です。
Cautionこれは危険情報です。特定の操作のリスクや悪影響を警告します。
七、テーブル(GFM)
| 機能 | 構文 | 説明 |
|---|---|---|
| 太字 | **text** | 太字表示 |
| 斜体 | *text* | 斜体表示 |
| ハイライト | ==text== | ハイライトマーク |
| 挿入 | ++text++ | 下線 |
八、コードブロック(Shiki ハイライト)
200以上の言語のシンタックスハイライトに対応しており、GitHub Light/Darkテーマを使用しています。
TypeScript
JSX/TSX
Diff マーク
九、数式(KaTeX)
インライン数式
の質量エネルギー等価式:$ E = mc^2 $
二次方程式の解の公式:$x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}$
多項式:$P(x) = anx^n+a{n-1}x^{n-1} + \dots + a1x + a0$
ブロック数式
十、脚注(GFM Footnotes)
脚注はインタラクティブなポップアッププレビューに対応しており、クリックすると脚注の定義箇所にジャンプできます。
これは脚注を含むテキストです[^1]。もう一つの脚注もあります[^note]。
十一、コンテナブロック(::: 構文)
警告/ヒントコンテナ
対応タイプ:info、warning、error、success、note(info と同等)、danger(error と同等)。
info と同等です。error と同等です。Bannerコンテナ
タイプは波括弧のパラメータで指定します:{warn}、{error}、{info}、{success}。
画像カルーセル(Gallery / Carousel)
Markdown 画像構文と直接 URL の2つの書き方に対応しており、gallery と carousel は同じ効果です。
グリッドレイアウト(Grid)
パラメータ:cols(列数)、gap(間隔、デフォルト 8)、rows(行数)、type(normal または images)。
Grid 第一セル
Grid 第二セル
Grid 第三セル
画像グリッド(Grid type=images)
メイソンリーレイアウト(Masonry)
パラメータ:gap(間隔、デフォルト 8)。レスポンシブで自動的に列数を調整します。
十二、リッチリンク自動埋め込み
独立した行の URL は自動的に認識され、リッチカードや埋め込みコンテンツとしてレンダリングされます。追加の構文は不要です。
GitHubリポジトリカード
GitHub Commit
GitHub PR
GitHub Issue
GitHubファイルプレビュー(コード行ハイライト付き)
GitHub Gist 埋め込み
https://gist.github.com/Innei/94b3e8f078d29e1820813a24a3d8b04e
YouTube 動画埋め込み
Twitter/Xツイート埋め込み
Bilibili 動画埋め込み
CodeSandbox 埋め込み
通常の外部リンク(自動プレビューカード)
特定のプラットフォームにマッチしない URL はプラグインによるマッチングが試行され、汎用的なリンクプレビューカードとしてレンダリングされます。
https://trpc.io/docs/client/react/useInfiniteQuery
インラインリンク(カードにはなりません)
URL が独立した行ではなく、段落の途中にある場合は、カードとしてレンダリングされず、通常のリンクとして表示されます。
Inline Innei
Inline https://github.com/Innei
十三、LinkCardコンポーネント
カスタム HTML タグを使用してリンクカードを手動で作成し、ソースと ID を正確に制御できます。
GitHubリポジトリカード
GitHub Commit カード
サイト内記事カード
サポートされているすべての source タイプ
十四、Tabsタブ
React はユーザーインターフェースを構築するための JavaScript ライブラリです。
十五、折りたたみパネル(Details / Summary)
アニメーション付きの展開/折りたたみに対応しており、印刷時は自動的に展開されます。
十六、動画
十七、特殊コードブロック
Mermaidフローチャート
flowchart TD
A[開始] --> B{条件判断}
B -->|はい| C[操作を実行]
B -->|いいえ| D[スキップ]
C --> E[終了]
D --> E
Excalidrawホワイトボード
Excalidraw のクリップボード JSON データをそのままコードブロックに貼り付けてレンダリングできます。
リモート Reactコンポーネントレンダリング
CDN 経由でリモート Reactコンポーネントを読み込み、ページにレンダリングします。
十八、区切り線
3つの書き方はすべて同じ効果です:
十九、HTMLインライン要素
上付き文字
x2 + y2 = z2
下付き文字
H2O は水の化学式です
二十、フォーマット早見表
| 分類 | 構文 | 説明 |
|---|---|---|
| 標準 Markdown | **太字** | 太字 |
*斜体* | 斜体 | |
`コード` | インラインコード | |
> 引用 | 引用ブロック | |
[テキスト](url) | リンク | |
 | 画像 | |
--- | 区切り線 | |
| GFM 拡張 | ~~取り消し線~~ | 取り消し線 |
- [x] タスク | タスクリスト | |
| テーブル | | テーブル | |
[^1] | 脚注 | |
> [!NOTE] | GitHub Alert | |
| Shiroi 拡張 | ||スポイラー|| | ホバーで表示 |
==ハイライト== | テキストマーク | |
++挿入++ | 下線/挿入 | |
{GH@user} | ソーシャル Mention | |
| 数式 | $ インライン数式 $ | KaTeX インライン |
$$ ブロック数式 $$ | KaTeX ブロック | |
| コンテナブロック | ::: info/warning/error/success | ヒントコンテナ |
::: banner {type} | Banner バナー | |
::: gallery / ::: carousel | 画像カルーセル | |
::: grid {cols=N,gap=N} | グリッドレイアウト | |
::: grid {type=images} | 画像グリッド | |
::: masonry {gap=N} | メイソンリーレイアウト | |
| カスタムコンポーネント | <LinkCard source="" id=""> | リンクカード(13種の source) |
<Tabs><Tab label=""> | タブ | |
<details><summary> | 折りたたみパネル | |
<Video src=""> | 動画再生 | |
| 特殊コードブロック | `mermaid | Mermaid 図表 |
`excalidraw | Excalidraw ホワイトボード | |
`component | リモート React コンポーネント | |
| リッチリンク | 独立行 URL | 自動埋め込みカード |