コードブロック
シンタックスハイライト、ヘッダーのファイル名、コピーボタン付きでコードを表示します。バリエーションをタブ付きのコードグループにまとめられます。
2026年11月19日更新
コードブロックは標準的な Markdown のフェンスです。Typemark は Shiki でハイライトし、言語またはファイル名を表示するヘッダーバーを追加します。
const response = await fetch("https://api.acme.com/users", {
headers: { Authorization: `Bearer ${apiKey}` },
});
const users = await response.json();
```javascript
const response = await fetch("https://api.acme.com/users", {
headers: { Authorization: `Bearer ${apiKey}` },
});
const users = await response.json();
```
コードブロックは、ライトモードとダークモードのどちらでも暗い背景で表示されます。
言語
言語名は開始のバッククォートの直後に書きます。Shiki は一般的な言語をほぼすべてカバーしており、例えば次のような言語があります。
| 分野 | 言語 |
|---|---|
| Web | javascript, typescript, jsx, tsx, html, css, scss, json, graphql |
| バックエンド | python, ruby, go, java, rust, php, c, cpp, csharp, kotlin, swift |
| 運用とデータ | bash, powershell, dockerfile, yaml, toml, sql, diff |
| ドキュメント | markdown, mdx |
js、ts、sh などの短い別名も使えます。言語を指定しない場合や、Shiki が認識しない言語を指定した場合は、ヘッダーバーなしのプレーンテキストとして表示されます。
ファイル名とタイトル
言語の後にファイル名を書くと、ヘッダーでは言語名の代わりにそのファイル名が表示されます。
from flask import Flask
app = Flask(__name__)
```python app.py
from flask import Flask
app = Flask(__name__)
```
title="…" を使うこともできます。ヘッダーには等幅フォントで表示され、フェンスにラベルと title の両方がある場合は、単純なラベルより title が優先されます。
production:
adapter: postgresql
pool: 5
```yaml title="config/database.yml"
production:
adapter: postgresql
pool: 5
```
| フェンスのオプション | 例 | 役割 |
|---|---|---|
| 言語 | ```ruby | ハイライトを設定します。ラベルや title がない場合はヘッダーに表示されます。 |
| ラベル | ```ruby Gemfile | 言語の後にある任意の単語です。ヘッダーに表示され、コードグループではタブ名として使われます。 |
title | ```ruby title="Gemfile" | ヘッダーに表示されます。ラベルがない場合にのみ、コードグループのタブ名として使われます。 |
言語の後にある wrap、lines などの語や、{1-3} のような範囲指定は無視されるため、ラベルに含まれることはありません。
コードグループ
コードグループは、複数のコードブロックを 1 つの枠の中のタブにまとめます。パッケージマネージャーごとの同じコマンドや、言語ごとに異なる同じ呼び出し方を並べるときに使います。
npm install @acme/sdk<CodeGroup>
```bash npm
npm install @acme/sdk
```
```bash yarn
yarn add @acme/sdk
```
```bash pnpm
pnpm add @acme/sdk
```
</CodeGroup>
各タブの名前は、ブロックのラベル、次に title、最後に言語の順で決まります。タブが分かりやすくなるよう、すべてのブロックにラベルを付けることをおすすめします。
const acme = require("@acme/sdk");
const client = new acme.Client({ apiKey: process.env.ACME_KEY });<CodeGroup>
```javascript Node.js
const acme = require("@acme/sdk");
const client = new acme.Client({ apiKey: process.env.ACME_KEY });
```
```python Python
import os, acme
client = acme.Client(api_key=os.environ["ACME_KEY"])
```
```ruby Ruby
require "acme"
client = Acme::Client.new(api_key: ENV["ACME_KEY"])
```
</CodeGroup>
<CodeGroup> は props を受け取りません。内部にはフェンス付きのコードブロックだけを置いてください。文章とコードを混在させたタブが必要な場合は、Tabs を使ってください。
コピーボタン
typemark.json で copy_code_button が有効になっていると、すべてのコードブロックに Copy ボタンが付きます。新しいプロジェクトでは初期状態で有効です。コードグループには、表示中のタブをコピーするボタンが 1 つ付きます。
{
"features": {
"copy_code_button": true
}
}
プロジェクト設定の Copy code button からも切り替えられます。
図表
言語に mermaid を指定したフェンスは、コードではなく図を描画します。Diagrams を参照してください。
インラインコード
テキストを 1 つのバッククォートで囲むと、インラインコードになります: npm run build。ビジュアルエディターでは、テキストを選択して Cmd+E を押します。
Run `npm run build` before you deploy.
ビジュアルエディターで
/ を入力して Code block または Code group を選びます。各ブロックの右上には言語のドロップダウンがあります。Plain text を選ぶと言語指定を外せます。
コードグループのタブは Tabs と同じように、追加、名前変更、並べ替え、削除ができます。タブの名前を変更すると、新しいラベルがそのブロックのフェンスに書き込まれるため、ソースモードでも ```bash npm のように読みやすいままです。