【AsciiDoc入門】箇条書き・チェックボックス・定義リストの極意をマスターしよう!

この記事は約5分で読めます。

前回の連載第2回「【AsciiDoc入門】基本のテキスト装飾・見出しと目次の自動生成をマスターしよう!」では、基本のテキスト装飾や見出しのルール、そして行頭に数行足すだけでサイドバーに目次を作ってくれる神機能(:toc:)について解説しました。アスタリスクを2つ重ねる「部分装飾」のコツもバッチリ掴めましたでしょうか?

連載第3回となる今回は、ドキュメントの読みやすさを大きく左右する「リスト(箇条書き)」を徹底解説します!

第1回の比較記事(https://niyanmemo.com/7489/ )でも触れた通り、AsciiDocはリストの表現力がMarkdownより遥かに強力です。普通の箇条書きから、ネスト(階層化)、チェックボックス、そして技術書などで大活躍する「定義リスト」まで、VS Codeでプレビューしながら使える実戦的なテクニックをお届けします。

1. 基本の箇条書き(順序なしリスト)

まずは最もよく使う、行頭に黒丸(ポッチ)がつく箇条書きです。

基本の書き方

Markdownでは -* を使いますが、AsciiDocでは アスタリスク * を使います。

  • 記述方法:* Linux
  • 注意点: * の後ろには、必ず半角スペースを1つ入れてください。

コードサンプル

* Linux 
* Python 
* Rust

見た目

階層化(ネスト)のやり方

Markdownではスペースを2個や4個空けて階層を作りますが、AsciiDocでは「アスタリスクの個数」で階層(レベル)を指定するという独特なルールを持っています。

  • 記述方法: * メイン言語
    ** Python
  • ここが便利!: 行頭のスペースの数を細かく気にする必要がないため、
    「スペースが1個足りなくてパースが崩れた!」というMarkdownあるあるのイライラから解放されます。

コードサンプル

* メイン言語
** Python
*** 機械学習
*** Web開発
** Rust
*** 組み込み

見た目

2. 番号付きリスト(順序ありリスト)

手順やランキングなどを表現する番号付きリストは、ドット . を使います。

  • 記述方法:. 環境構築を行う(第1回参照)
    . 基本文法を覚える(第2回参照)
  • ここが便利!: Markdownと同様に、自動で「1. 2. 3.」と連番を振ってくれます。
    こちらも、. を2つに増やして .. と書くことで、番号付きリストの中でさらに階層を下げることができます。

コードサンプル

. 環境構築を行う(第1回参照)
.. テスト
... テスト2
. 基本文法を覚える(第2回参照)
. リストの書き方をマスターする(今回)

見た目

3. タスク管理に便利!チェックボックス(インタラクティブリスト)

ToDoリストや進捗管理に使えるチェックボックス付きのリストも、標準のシンタックスでサクッと書けます。

  • 記述方法:* [ ] 第3回の記事を下書きする
    * [x] 第2回の部分装飾のミスを直す
  • 見た目:
    • [ ] 第3回の記事を下書きする
    • [x] 第2回の部分装飾のミスを直す
    • [ ] ブログのアイキャッチ画像を作る

[ ] で未チェック、[x](小文字のx)を入れることでチェック済みの状態を表現できます。

コードサンプル

* [ ] 第3回の記事を下書きする
* [x] 第2回の部分装飾のミスを直す
* [ ] ブログのアイキャッチ画像を作る

見た目

4. 技術ドキュメントの必須機能「定義リスト」

AsciiDocのリスト機能の中で、Markdownユーザーが一番羨むのがこの「定義リスト(Description List)」です。「用語」と「その説明文」をセットで綺麗にレイアウトしてくれます。

基本の書き方

用語の後ろに コロンを2つ :: 続け、改行するかスペースを空けて説明文を書きます。

  • 記述方法:Linux:: オープンソースのオペレーティングシステム。サーバーや開発環境で広く使われています。

見た目のイメージ

Linux オープンソースのオペレーティングシステム。サーバーや開発環境で広く使われています。 Python シンプルで読みやすいプログラミング言語。AI開発や自動化スクリプトに最適です。

用語が自動的に太字になり、説明文が1段下がって(インデントされて)配置されます。Markdownでこれをつくろうとすると、わざわざHTMLタグ(<dl> <dt> <dd>)を書くか、太字と改行を組み合わせる必要がありましたが、AsciiDocならコロン2つでスマートに解決します。

コードサンプル

Linux:: オープンソースのオペレーティングシステム。サーバーや開発環境で広く使われています。
Python:: シンプルで読みやすいプログラミング言語。AI開発や自動化スクリプトに最適です。
Rust:: メモリ安全性を誇るコンパイル言語。パフォーマンスを重視するシステム開発に人気。

見た目

5. まとめ

今回は、AsciiDocの表現力をグッと高める「リスト機能」について解説しました。

  • 箇条書きは *、階層を深くするときは と増やす
  • 番号付きリストは . を使う
  • チェックボックスは * [ ]* [x]
  • 用語の解説には、コロン2つの 用語:: 説明(定義リスト)を使う

スペースの数に依存しない階層化や、標準の定義リストは、一度慣れるとMarkdownに戻れなくなるほど快適です。ぜひVS Codeのリアルタイムプレビューでこの快適さを体感してみてください。

次回(第4回)は、仕様書や技術書、長文ブログを執筆するときの真の最強機能「【神機能】ファイルの分割と結合(include)」をお届けします。1万文字を超えるような大容量ドキュメントを、驚くほど綺麗にパーツ分けして管理する実践テクニックです。

コメント

タイトルとURLをコピーしました