コードブロックガイドライン
コードブロックを作成するには、次の方法があります。
- コードブロックの周りにトリプルアキュート文字を「フェンス」として使用します。(推奨)
- 行を4つのスペースまたは1つのタブでインデントします。
コードブロックで使用される構文ハイライト言語を定義するには、最初のフェンスの後に言語名を入力します。サポートされている言語のリストについては、Cloudflare開発者ドキュメントで使用される言語のリストを参照してください。
適切な構文ハイライトがない場合は、txt言語を使用します(たとえば、Apache設定ファイルの断片など)。
```json{ "firstName": "John", "lastName": "Smith", "age": 25}```レンダリングされた出力は次のようになります。
{ "firstName": "John", "lastName": "Smith", "age": 25}-
Linux/macOSターミナルで実行される1行コマンドには、
sh言語を使用します(各コマンドは1行でなければなりません)。 -
その他のLinux/macOS/一般的なコマンドには、
bash言語を使用します。たとえば:- 複数行にわたるコマンド(通常、各行は
\で終わり、1行以上のJSONコンテンツを含む場合があります)。 - 特定のシェル用のコマンド(たとえば、プロンプトが通常
%であるzshシェル専用のコマンド)。
- 複数行にわたるコマンド(通常、各行は
-
Windows PowerShellコマンドには、
powershell言語を使用します。 -
Windowsコンソールコマンドには、
txt言語を使用します。
「$」(ドル記号、スペース)または「FOLDER_NAME $」(フォルダ名、スペース、ドル記号、スペース)を使用します。
例:
$command-to-run- ~/my-folder
$command-to-run(ここで~は現在のユーザーのホームフォルダを意味します)。
Linux/macOS/一般的なコマンドを含むブロック:
- コードブロックが1つの(複数行の)コマンドのみを含む場合、ユーザーがプレフィックスを削除せずにコマンドをすぐに実行できるように、
$プレフィックスを含めないでください。 - コードブロックに複数のコマンドが含まれている場合や出力が含まれている場合は、コマンドとその出力を区別するために、各コマンドの前にプレフィックスを含めることを検討してください。
shブロックで説明されているのと同じプレフィックスを使用します。 - zsh専用の指示には、
$の代わりに%コマンドプレフィックスを使用できます。
「PS FOLDER_NAME>」(>はプロンプトの一部であり、その後にスペースがあります)を使用します。
例:
- PS C:\> command-to-run.exe
- PS C:\Users\JohnDoe> command-to-run.exe
「FOLDER_NAME>」(フォルダ名、大なり記号、後にスペースなし)を使用します。
または、プロンプトを含めず、ユーザーが入力すべきコマンドで行を開始します(何を入力すべきか、何が例の出力であるかを理解するのが難しくなることを知りながら)。
例:
- C:\>command-to-run.exe
- C:\Program Files>command-to-run.exe
- C:\Users\JohnDoe>command-to-run.exe
JSONコードブロックまたはJSON断片には、json言語を使用します。
JSONボディを持つ複数行のcurlコマンドは、ターミナルコマンドの表示で述べたように、bash構文ハイライトを使用する必要があります。
bash(エイリアス:curl)cdiffgographqlhcl(エイリアス:tf)htmlinijavajs(エイリアス:javascript)jsonkotlinphppowershellpython(エイリアス:py)ruby(エイリアス:rb)rust(エイリアス:rs)sh(エイリアス:shell)sqlswifttomlts(エイリアス:typescript)txt(エイリアス:text、plaintext)xmlyaml(エイリアス:yml)
これらの言語の異なる大文字小文字のバリエーションもサポートされています(ただし推奨されません)。たとえば、JavaScriptはjavascript言語を使用し、HTMLはhtml言語を使用します。