gists

tldr-pages のページフォーマット

概要

tldr-pages は、コマンドラインツールの簡易ヘルプページ集。従来の man ページをよりシンプルに、実用的な例を中心にまとめたコミュニティプロジェクト。全コマンドが同じテンプレートで統一されている。

テンプレート構造

# コマンド名

> 1行の簡潔な説明
> 補足説明（任意、複数行可）
> See also: `関連コマンド`.（任意）
> More information: <公式ドキュメントURL>.

- やりたいことの説明:

`コマンド例`

- やりたいことの説明:

`コマンド例`

各パーツの書き方

1. ヘッダー

• # コマンド名 のみ

2. 概要ブロック（> 引用）

行	内容	必須
1行目	コマンドの簡潔な説明	Yes
中間行	補足情報（用途・注意点など）	No
See also	関連コマンドへの参照	No
More information	公式ドキュメントへのリンク	Yes

3. 例（- 説明 + バッククォートのコマンド）

• 説明文: - ○○する: の形式（コロンで終わる）
• コマンド: バッククォート ` で囲む（1行）
• 例の数: 最大 8 個まで

記法ルール

プレースホルダー ``

可変部分は二重波括弧で囲む。

オプション表記 [-X|--xxx]

短縮形と完全形を | で併記し、`` で囲む。

 
 ''

ニーモニック []

覚えやすい文字を角括弧で強調する（tar の例が代表的）。

- [c]reate an archive and write it to a [f]ile:
- E[x]tract a (compressed) archive [f]ile:
- Lis[t] the contents of a tar [f]ile [v]erbosely:

実例: tar

# tar

> Archiving utility.
> Often combined with a compression method, such as `gzip` or `bzip2`.
> More information: <https://www.gnu.org/software/tar/manual/tar.html>.

- [c]reate an archive and write it to a [f]ile:

`tar cf  `

- E[x]tract a (compressed) archive [f]ile into the current directory [v]erbosely:

`tar xvf `

ディレクトリ構成

pages/           # 英語（原本）
  common/        # クロスプラットフォーム
  linux/         # Linux 固有
  osx/           # macOS 固有
  windows/       # Windows 固有
pages.ja/        # 日本語翻訳
pages.zh/        # 中国語翻訳
...              # その他の言語

This site is open source. Improve this page.