構造をつくって、考えを整理する。
見出し、コード、引用、表。AsciiDocで少し長めの記録を書くためのサンプルです。
目次
文章が長くなってきたら、見出しを並べて全体を眺めてみます。区切りを作ると、どこに何を書きたいのかが見えてきます。
このページはAsciiDocの書式確認用サンプルです。実際の活動や体験を記したものではありません。
Figure 1. 記事と同じフォルダーに置いたSVGです。
見出しで道筋をつくる
まず伝えたいことを見出しにして、その下に材料を集めます。順番は後から変えられます。
主題を一つ決める
必要な説明を並べる
読み返して、重複を減らす
Note | AsciiDocの記事は、Hugoとこのブログが固定するRust製パーサでビルドします。 |
コードを添える
ソースコードの言語を指定すると、Rust製パーサがRouge互換のCSSクラスで色分けします。
notes = ["見つける", "書き留める", "読み返す"]
notes.each do |note|
puts note
end引用を添える
引用には著者名と出典を添えます。ルイス・キャロル『不思議の国のアリス』の一節です。
“Begin at the beginning,” the King said gravely, “and go on till you come to the end: then stop.”
— Lewis Carroll
Alice’s Adventures in Wonderland — Chapter XII
Alice’s Adventures in Wonderland — Chapter XII
表で見比べる
| 要素 | 役割 |
|---|---|
見出し | 話題のまとまりを示す |
リスト | 手順や要点を並べる |
表 | 複数の項目を見比べる |
余白を残しておく
最初からすべてを書き切らなくても大丈夫です。足りない説明に気づいたら、追記していけます。