箱の見本

このページは、ブログの箱(枠組み)の見本である。記事ではない。 本文に書ける部品を全部並べて、そろって出ているかを人の目と出力の検査の両方で確かめるために置いている。読み物として読む中身は無い。

枠は4種類ある

要点

要点の枠。その節で言いたいことを1つだけ書く。

補足

補足の枠。本筋から外れる説明や、前提の補いに使う。

注意

注意の枠。読者が損をしかねないこと、取り返しがつかないことに使う。

チェック: 公開の前に見る

チェックの枠。:::check[見出し] のように書くと、枠に見出しを足せる。

枠は入れ子にできる

補足

外側の枠。入れ子にするときは、外側のコロンを1つ増やす(::::note の中に :::warning)。

注意

内側の枠。外側と同じ数のコロンで書くと、外側が早く閉じて最後の ::: が本文に出る。

枠の中にも、箇条書きと図を書ける

補足

  • 箇条書きの項目
  • 2つ目の項目
記事がページになるまでを3つの箱で示した図(同じ図を枠の中に置いた例)
枠の中にも図を置ける

図には、説明と説明文を付ける

Markdown の記事、ビルドと検査、公開されるページの3つを上から矢印でつないだ図。検査に通らなければ、公開されるページに進まずに止まる
図1: 記事が公開されるまでの流れ

図は ![何が写っているか](./図.svg "図の下に出す説明文") の形で書く。前の括弧の説明は読み上げと検索のためのもので、省くとビルドが落ちる。

説明文が下に出るのは、段落に画像だけを書いたときである。 文の中に混ぜた画像 小さい図 は図の箱に入らず、説明文は画像の吹き出しのまま残る。

補足

箇条書きの項目の中の画像も、同じく図の箱に入らない。

  • 箇条書きの中の図

表は、横にスクロールできる

部品 書き方 出る形
枠 :::note と ::: で囲む 種類の名前が付いた囲み
図 ![説明](./図.svg "説明文") 説明文の付いた図
表 Markdown の表 横にスクロールできる箱
目次 見出し(##・###)を書く 本文の上に自動で出る
脚注 本文に [^1]、別の行に [^1]: 中身 本文の末尾に並び、行き来できる

表は横にスクロールできる箱に入っている。列が多くて本文の幅に収まらないときは、この箱だけが横に動き、ページ全体は動かない。日本語は文字の途中でも折り返せるので、この見本の表のように列が少なければ、狭い画面でも収まって箱は動かない。

そのほかの書き方

段落の中では、太字と インラインのコード と 本体のサイトへのリンク が使える。

引用は、行の先頭に大なり記号を付けて書く。

コードの塊は、バッククォート3つの行で囲んで書く。長い1行を書いても、塊の中だけが横にスクロールする。

bun run build && ARTICLES_DIR=記事 bunx astro build --force --outDir ../dist/blog
  1. 番号付きの箇条書き
  2. 2つ目の項目

見出しは2段まで目次に出る

目次に出るのは ##(節)と ###(小節)である。# は題名として本文の上に出るので、本文には書かない。

文中のコロンは、そのまま文字として出る

12:30 に始めて、画面の比は 3:2 である。コロンを使う記法は決めていないので、:red[このように書いた場合] もそのまま出る。

出典は脚注に書ける

本文に [^1] と書き、別の行に [^1]: 中身 と書くと、本文の末尾に脚注が並ぶ1。脚注の番号から本文へ戻れる。

ここに無い部品は、まだ作っていない

この見本に並んでいるものが、いま本文に書ける部品のすべてである。開閉する枠・賛否を並べる枠・会話の吹き出し・用語の定義といった部品は、要求の文書にはあるがまだ作っていない。必要になったら engineering に相談する。

脚注

  1. 脚注の中身。出典の URL や、本文に入れると流れが切れる補いを書く。 ↩