Marxdown
日本語English
ダウンロード

ガイド

記法

Marxdown が表示できる Markdown の書き方です。左が書き方、右が表示です。

基本

CommonMark に従います。GitHub と同じ書き方で、同じように表示されます。

見出し

行頭の # の数が階層になります。見出しはアウトラインにも並びます。

書き方 
# 見出し 1## 見出し 2### 見出し 3
表示

見出し 1

見出し 2

見出し 3

段落と改行

空行で段落を分けます。段落の中の改行は、既定ではつながって表示されます。行末に空白 2 つか \ を置くと改行になります。設定の「段落内の改行を反映」をオンにすると、改行をそのまま表示します。

書き方 
1 つ目の段落です。この行は前の行につながります。2 つ目の段落です。\ここで改行されます。
表示

1 つ目の段落です。 この行は前の行につながります。

2 つ目の段落です。
ここで改行されます。

強調

エディターでは Ctrl+B（太字）・Ctrl+I（斜体）・Ctrl+Shift+X（取り消し線）で付け外しできます。

書き方 
**太字**、*斜体*、~~取り消し線~~、`インラインコード`
表示

太字、斜体、取り消し線、インラインコード

リスト

- か数字で始めます。字下げすると入れ子になります。エディターでは Tab / Shift+Tab で字下げ / 字上げできます。

書き方 
- りんご- みかん  - 温州みかん  - 伊予柑1. 読む2. 書く3. 保存する
表示
  • りんご
  • みかん
    • 温州みかん
    • 伊予柑
  1. 読む
  2. 書く
  3. 保存する

引用

行頭に > を置きます。エディターでは Ctrl+Shift+. で付け外しできます。

書き方 
> 読みやすさは、設定できる。>> > 入れ子にもできます。
表示

読みやすさは、設定できる。

入れ子にもできます。

コードブロック

``` で囲み、言語名を添えるとシンタックスハイライトします。対応する言語は Bash・C・C++・C#・CSS・Diff・Go・INI / TOML・Java・JavaScript・JSON・Markdown・Python・Rust・SQL・TypeScript・HTML / XML・YAML です。

書き方 
```rustfn main() {    let name = "Marxdown";    println!("Hello, {name}!");}```
表示
fn main() {
    let name = "Marxdown";
    println!("Hello, {name}!");
}

区切り線

--- だけの行が区切り線になります。

書き方 
前の話題---次の話題
表示

前の話題

次の話題

HTML

HTML も書けます。ただし、スクリプトや onclick などのイベント属性は取り除かれ、実行されません。

書き方 
<details><summary>クリックで開く</summary>折りたたまれていた内容です。</details><kbd>Ctrl</kbd>+<kbd>S</kbd> で保存
表示
クリックで開く

折りたたまれていた内容です。

Ctrl+S で保存

GitHub の拡張

GitHub Flavored Markdown の拡張と、GitHub のアラートに対応しています。

表

2 行目の : の位置で揃えを指定します。エディターでは Tab で次のセルへ移動でき、Shift+Alt+F で列幅を揃えられます。罫線の引き方は設定の「表の罫線」で選べます。

書き方 
| 方式 | p95 | 実装コスト || :--- | ---: | :---: || キャッシュなし | 240ms | 低 || TTL | 22ms | 低 || Stale-While-Revalidate | 18ms | 中 |
表示
方式 p95 実装コスト
キャッシュなし 240ms 低
TTL 22ms 低
Stale-While-Revalidate 18ms 中

タスクリスト

エディターでは Ctrl+Enter でチェックを切り替えられます。

書き方 
- [x] 方式を比較する- [ ] 失効のメトリクスを追加する- [ ] 負荷試験
表示
  • 方式を比較する
  • 失効のメトリクスを追加する
  • 負荷試験

アラート

GitHub と同じ 5 種類です。見出しは GitHub と同じ英語で表示します。

書き方 
> [!NOTE]> 補足です。> [!TIP]> 知っておくと便利なことです。> [!IMPORTANT]> 大事なことです。> [!WARNING]> 注意が必要です。> [!CAUTION]> 危険を伴います。
表示

Note

補足です。

Tip

知っておくと便利なことです。

Important

大事なことです。

Warning

注意が必要です。

Caution

危険を伴います。

脚注

脚注は文書の末尾にまとめて表示します。

書き方 
Marxdown は Tauri で作られています[^1]。[^1]: Rust と WebView で動くアプリの枠組みです。
表示

Marxdown は Tauri で作られています[1]。

  1. Rust と WebView で動くアプリの枠組みです。 ↩︎

数式と図

数式

$ で囲むと文中に、$$ で囲むと独立した行に、KaTeX で表示します。$5 と $10 のような金額は数式になりません。

書き方 
平均遅延はおおよそ $\bar{t} = h \cdot t_c + (1 - h) \cdot t_m$ です。$$\sum_{k=1}^{n} k = \frac{n(n+1)}{2}$$
表示

平均遅延はおおよそ tˉ=h⋅tc+(1−h)⋅tm\bar{t} = h \cdot t_c + (1 - h) \cdot t_m です。

∑k=1nk=n(n+1)2\sum_{k=1}^{n} k = \frac{n(n+1)}{2}

図（Mermaid）

mermaid のコードブロックを図として表示します。フローチャート・シーケンス図・ガントチャートなど、Mermaid の図はすべて使えます。

書き方 
```mermaidsequenceDiagram  ターミナル->>Marxdown: marxdown README.md  Marxdown-->>ターミナル: すぐにプロンプトへ戻る  Marxdown->>Marxdown: タブで開く```
表示
sequenceDiagram ターミナル->>Marxdown: marxdown README.md Marxdown-->>ターミナル: すぐにプロンプトへ戻る Marxdown->>Marxdown: タブで開く

文書の設定

Front Matter

先頭の --- で囲んだ YAML は、本文とは分けて表で表示します。設定の「Front Matter」で、YAML のままの表示や非表示にも切り替えられます。

書き方 
---title: 設計メモtags: [cache, api]---# 設計メモ
表示
title設計メモ
tags
  • cache
  • api

設計メモ

Marp のスライド

Front Matter に marp: true を書くと、Marp のスライドとして表示します。--- でスライドを区切ります。自作のテーマは設定の「Marp のテーマ」で読み込めます。

書き方 
---marp: truetheme: defaultpaginate: true---# キャッシュ戦略検索 API の p95 を下げる---## 結論Stale-While-Revalidate を採用する
スライドの見本

キャッシュ戦略

検索 API の p95 を下げる

1

結論

Stale-While-Revalidate を採用する

2

スライドとして 1 枚ずつ表示します。

追加記法

標準ではない記法です。意図せず本文の表示が変わらないよう、どれも既定ではオフになっています。設定の「記法」で 1 つずつ有効にできます。

マーカー

markdown.marks

==文字== を蛍光ペンで塗ったように表示します。

書き方 
結論は ==Stale-While-Revalidate== です。
表示

結論は Stale-While-Revalidate です。

挿入

markdown.insertions

++文字++ を下線付きで表示します。

書き方 
p95 は ++18ms++ になりました。
表示

p95 は 18ms になりました。

上付き文字

markdown.superscript

^ で囲んだ文字を上付きで表示します。

書き方 
E = mc^2^
表示

E = mc2

下付き文字

markdown.subscript

~ で囲んだ文字を下付きで表示します。

書き方 
H~2~O
表示

H2O

定義リスト

markdown.definitionLists

用語の次の行を : で始めると、定義リストとして表示します。

書き方 
TTL: 決まった時間が経つと失効させる方式Stale-While-Revalidate: 古い応答を返しつつ、裏で更新する方式
表示
TTL
決まった時間が経つと失効させる方式
Stale-While-Revalidate
古い応答を返しつつ、裏で更新する方式

略語

markdown.abbreviations

*[略語]: 説明 の形で定義した語に、マウスを重ねると説明を表示します。

書き方 
CSP で読み込めるものを制限します。*[CSP]: Content Security Policy
表示

CSP で読み込めるものを制限します。

複数行の表

markdown.multilineTables

行の最後の | の後ろに \ を置くと、次の行を同じセルの続きとして書けます。続けた行はまとめて Markdown として解釈されるため、セルの中にリストも書けます。^^ と書いたセルは、上のセルと縦に結合します。

書き方 
| 方式 | 特徴 | コスト || --- | --- | --- || TTL | - 決まった時間で失効させる | 低 |\|     | - 実装が簡単 | || キャッシュなし | 常に最新を返す | ^^ || SWR | 古い応答を返しつつ更新する | 中 |
表示
方式 特徴 コスト

TTL
  • 決まった時間で失効させる
  • 実装が簡単

低
キャッシュなし 常に最新を返す
SWR 古い応答を返しつつ更新する 中
↑↓ で選択 · Enter で移動 · Esc で閉じる