本ドキュメントでは、Shiroiブログシステムがサポートするすべての Markdown フォーマットを紹介しています。各機能にはコードと効果の2つのパートが含まれています。
太字テキスト と もう一つの太字
斜体テキスト と もう一つの斜体
太字斜体テキスト
取り消し線テキスト
これは インラインコード の例です
で内容が表示されます。
これは ネタバレ内容、マウスホバーで表示 を含むテキストです。
これは ハイライトされた テキストです。
これは 挿入されたテキスト です。
GitHub(GH)、Twitter(TW)、Telegram(TG)の3つのプラットフォームに対応しています。
見出しは自動的にアンカーリンクが生成され、日本語文字の slug にも対応しています。
(見出しの効果は本ドキュメントの各セクションをご覧ください)
これは通常の引用テキストです。
ネストされた引用もサポートされています。
注意:隣接する複数の Alert の間には <div /> で区切る必要があります。そうしないと1つの引用ブロックに統合されてしまいます。
[!NOTE] これは注意情報です。ユーザーが知っておくべき補足説明に使用します。
Tipこれはヒント情報です。より良い操作方法を提案します。
Importantこれは重要情報です。目標を達成するためにユーザーが知る必要があります。
Warningこれは警告情報です。問題を回避するためにユーザーの即座の注意が必要です。
Cautionこれは危険情報です。特定の操作のリスクや悪影響について注意を促します。
| 機能 | 構文 | 説明 |
|---|---|---|
| 太字 | **text** | 太字表示 |
| 斜体 | *text* | 斜体表示 |
| ハイライト | ==text== | マークハイライト |
| 挿入 | ++text++ | 下線 |
200以上の言語のシンタックスハイライトに対応しており、GitHub Light/Darkテーマを使用しています。
の質量エネルギー等価式:$ 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$
脚注はインタラクティブなポップアッププレビューに対応しており、クリックすると脚注の定義箇所にジャンプできます。
これは脚注を含むテキストです[^1]。もう一つの脚注もあります[^note]。
対応タイプ:info、warning、error、success、note(info と同等)、danger(error と同等)。
info と同等です。error と同等です。タイプは波括弧のパラメータで指定します:{warn}、{error}、{info}、{success}。
Markdown 画像構文と直接 URL の2つの書き方に対応しており、gallery と carousel は同じ効果です。
:cols(列数)、gap(間隔、デフォルト 8)、rows(行数)、type(normal または images)。
Grid 第一セル
Grid 第二セル
Grid 第三セル
:gap(間隔、デフォルト 8)。レスポンシブで自動的に列数を調整します。
独立した行の URL は自動的に認識され、リッチカードや埋め込みコンテンツとしてレンダリングされます。追加の構文は不要です。
https://gist.github.com/Innei/94b3e8f078d29e1820813a24a3d8b04e
特定のプラットフォームにマッチしない URL は、プラグインによるマッチングを試み、汎用的なリンクプレビューカードとしてレンダリングされます。
https://trpc.io/docs/client/react/useInfiniteQuery
URL が独立した行ではなく、段落の途中にある場合、カードとしてはレンダリングされず、通常のリンクになります。
Inline Innei
Inline https://github.com/Innei
カスタム HTML タグを使用してリンクカードを手動で作成し、ソースと ID を正確に制御できます。
React はユーザーインターフェースを構築するための JavaScript ライブラリです。
による展開/折りたたみに対応しており、印刷時は自動的に展開されます。
Excalidraw のクリップボード JSON データをそのままコードブロックに貼り付けてレンダリングできます。
CDN 経由でリモート Reactコンポーネントを読み込み、ページにレンダリングします。
3つの書き方はすべて同じ効果です:
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 | 自動埋め込みカード |
**太字テキスト** と __もう一つの太字__
*斜体テキスト* と _もう一つの斜体_
***太字斜体テキスト***
~~取り消し線テキスト~~
これは `インラインコード` の例です
これは ||ネタバレ内容、マウスホバーで表示|| を含むテキストです。
これは ==ハイライトされた== テキストです。
これは ++挿入されたテキスト++ です。
[Innei]{GH@Innei}
{TW@example}
{TG@example}
# 見出し1
## 見出し2
### 見出し3
#### 見出し4
##### 見出し5
###### 見出し6
- 第一項目
- ネスト 1.1
- ネスト 1.2
- 第二項目
- 第三項目
1. ステップ1
2. ステップ2
1. サブステップ 2.1
2. サブステップ 2.2
1. サブステップ 2.2.1
3. ステップ3
- [ ] 未完了のタスク
- [x] 完了したタスク
- [ ] もう一つの TODO 項目
[Innei のブログ](https://innei.in)
<https://github.com/Innei>

> これは通常の引用テキストです。
>
> > ネストされた引用もサポートされています。
> [!NOTE]
> これは**注意**情報です。ユーザーが知っておくべき補足説明に使用します。
<div />
> [!TIP]
> これは**ヒント**情報です。より良い操作方法を提案します。
<div />
> [!IMPORTANT]
> これは**重要**情報です。目標を達成するためにユーザーが知る必要があります。
<div />
> [!WARNING]
> これは**警告**情報です。問題を回避するためにユーザーの即座の注意が必要です。
<div />
> [!CAUTION]
> これは**危険**情報です。特定の操作のリスクや悪影響について注意を促します。
| 機能 | 構文 | 説明 |
|------|------|------|
| 太字 | `**text**` | 太字表示 |
| 斜体 | `*text*` | 斜体表示 |
| ハイライト | `==text==` | マークハイライト |
| 挿入 | `++text++` | 下線 |
```typescript
interface User {
name: string
age: number
}
const greet = (user: User): string => {
return `Hello, ${user.name}!`
}
```
interface User {
name: string
age: number
}
const greet = (user: User): string => {
return `Hello, ${user.name}!`
}
```tsx
const App: React.FC = () => {
const [count, setCount] = useState(0)
return (
<button onClick={() => setCount(count + 1)}>
Count: {count}
</button>
)
}
```
const App: React.FC = () => {
const [count, setCount] = useState(0)
return (
<button onClick={() => setCount(count + 1)}>
Count: {count}
</button>
)
}
```diff
- const old = "removed"
+ const new = "added"
```
- const old = "removed"
+ const new = "added"
<ruby>アインシュタイン<rt>Einstein</rt></ruby>の質量エネルギー等価式:$ E = mc^2 $
二次方程式の解の公式:$x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}$
多項式:$P(x) = a_nx^n+a_{n-1}x^{n-1} + \dots + a_1x + a_0$
$$
P\left(U,T\right)=100\left.\left(0.6\min\left(1,\frac{U-0.70}{0.90-0.70}\right)+0.4\min\left(1,\frac{T-4000}{14000-4000}\right)\right)\right.
$$
$$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$
これは脚注を含むテキストです[^1]。もう一つの脚注もあります[^note]。
[^1]: これは最初の脚注の内容です。
[^note]: これは2番目の脚注の内容で、インタラクティブなポップアッププレビューに対応しています。
::: info
これは **情報** ヒントで、内部の Markdown <ruby>レンダリング<rt>rendering</rt></ruby>に対応しています。
:::
::: warning
これは **警告** ヒントです。関連する内容にご注意ください。
:::
::: error
これは **エラー** ヒントで、重大な問題を示しています。
:::
::: success
これは **成功** ヒントで、操作が正常に完了しました。
:::
::: note
これも情報ヒントの別名で、`info` と同等です。
:::
::: danger
これもエラーヒントの別名で、`error` と同等です。
:::
::: banner {warn}
banner 構文で作成された警告<ruby>バナー<rt>banner</rt></ruby>です。タイプは<ruby>パラメータ<rt>parameter</rt></ruby>で指定します。
:::
::: banner {info}
banner 構文で作成された情報<ruby>バナー<rt>banner</rt></ruby>です。
:::
::: gallery



:::
::: carousel
https://loremflickr.com/640/480/nature?1
https://loremflickr.com/640/480/nature?2
https://loremflickr.com/640/480/nature?3
:::
::: grid {cols=3,gap=8}
Grid 第一セル
Grid 第二セル
Grid 第三セル
:::
::: grid {cols=3,rows=3,gap=12,type=images}









:::
::: masonry {gap=8}




:::
https://github.com/Innei/Shiro
https://github.com/vuejs/vitepress/commit/71eb11f72e60706a546b756dc3fd72d06e2ae4e2
https://github.com/Innei/Shiro/pull/129
https://github.com/Innei/Shiro/issues/100
https://github.com/Innei/Shiro/blob/108d4c3e927e1c9c9304e41a0631f91958477d9f/src/providers/root/modal-stack-provider.tsx
https://gist.github.com/Innei/94b3e8f078d29e1820813a24a3d8b04e
https://www.youtube.com/watch?v=N93cTbtLCIM
https://twitter.com/zhizijun/status/1649822091234148352?s=20
https://www.bilibili.com/video/BV1xx411c7mD
https://codesandbox.io/s/framer-motion-layoutroot-prop-forked-p39g96
https://trpc.io/docs/client/react/useInfiniteQuery
Inline [Innei](https://github.com/Innei)
Inline https://github.com/Innei
<LinkCard source="gh-repo" id="mx-space/kami">
<LinkCard source="gh-commit" id="mx-space/kami/commit/e1eee4136c21ab03ab5690e17025777984c362a0">
<LinkCard source="self" id="posts/programming/hello-world">
<!-- GitHub シリーズ -->
<LinkCard source="gh-repo" id="owner/repo">
<LinkCard source="gh-commit" id="owner/repo/commit/sha">
<LinkCard source="gh-pr" id="owner/repo/number">
<LinkCard source="gh-issue" id="owner/repo/number">
<LinkCard source="gh-discussion" id="owner/repo/number">
<!-- サイト内コンテンツ -->
<LinkCard source="self" id="posts/category/slug">
<LinkCard source="self" id="notes/nid">
<!-- メディア -->
<LinkCard source="tmdb" id="movie/12345">
<LinkCard source="bangumi" id="subject/12345">
<LinkCard source="qq-music-song" id="song-id">
<LinkCard source="netease-music-song" id="song-id">
<!-- 学術 / コード -->
<LinkCard source="arxiv" id="2301.00001">
<LinkCard source="leetcode" id="two-sum">
<Tabs>
<Tab label="React">
React はユーザーインターフェースを構築するための JavaScript ライブラリです。
</Tab>
<Tab label="Vue">
Vue は<ruby>プログレッシブ<rt>progressive</rt></ruby>な JavaScript <ruby>フレームワーク<rt>framework</rt></ruby>です。
</Tab>
<Tab label="Svelte">
Svelte は<ruby>コンパイル<rt>compile</rt></ruby>時<ruby>フロントエンド<rt>frontend</rt></ruby><ruby>フレームワーク<rt>framework</rt></ruby>です。
</Tab>
</Tabs>
<details>
<summary>クリックして詳細を展開</summary>
ここは折りたたまれた内容で、内部の Markdown レンダリングに対応しています。
- リスト項目 1
- リスト項目 2
**太字** と *斜体* も正常に使用できます。
</details>
<Video src="https://example.com/video.mp4" />
```mermaid
flowchart TD
A[開始] --> B{条件判断}
B -->|はい| C[操作を実行]
B -->|いいえ| D[スキップ]
C --> E[終了]
D --> E
```
```excalidraw
{"type":"excalidraw/clipboard","elements":[{"type":"rectangle","version":14,"versionNonce":1361369853,"isDeleted":false,"id":"_PSpf6pLwkWIJubC_tf9D","fillStyle":"solid","strokeWidth":2,"strokeStyle":"solid","roughness":1,"opacity":100,"angle":0,"x":545.0390625,"y":387.296875,"strokeColor":"#1e1e1e","backgroundColor":"transparent","width":177.53515625,"height":138.328125,"seed":1495751197,"groupIds":[],"frameId":null,"roundness":{"type":3},"boundElements":[],"updated":1706954302946,"link":null,"locked":false}],"files":{}}
```
```component
import=https://cdn.jsdelivr.net/npm/@innei/react-cdn-components@0.0.7/dist/components/Firework.js
name=MDX.Firework
height=25
```
---
***
___
x<sup>2</sup> + y<sup>2</sup> = z<sup>2</sup>
H<sub>2</sub>O は水の化学式です