markdown覚えて、スマートでUDな文書つくりましょう

markdown覚えて、スマートでUDな文書つくりましょう

小田浩一, 2024/8/23-9/30

markdownとは何か？

　技術的なドキュメンテーションしている人の間では人気があるようなのが、markdownエディタというアプリ。プログラムコードについての解説を書いたりするのに、キーボードから手を離さずに、文字だけタイプしつつ、読みやすいテキストが書ける。

　「いや、プログラムコードの解説とか関係ないし」という人にもかなり使い勝手が良いし、これを使って書くと視覚に障害があったり、読書障害があったりする人にもアクセスしやすいユニバーサルな文書が作成できる。

　視覚障害とか読書障害とかあんまり関心ないし、という人にも十分なご利益がある。後で詳しく書くように、文書を作成していく時点での利点もとても多いのだが、自分の書いた文書の永続性・再利用可能性という点から圧倒的に優れている。例えばWord文書はWordというアプリが時代遅れになったときにどうなるのか？という問題がある。特定のアプリで作成した文書は、そのアプリとともに開けなくなる可能性を必ず秘めている。究極的にはテキストファイルやJPEGのような一般的な規格のものだけしか後世まで生き残らないかもしれない。いや、自分が生きている間にもアプリとともに再利用できなくなった文書は大量にある。AppleWorksやPageMakerで作成した力作はもう再利用できない。自分の知的生産の結果を未来に残していくときにどんなファイル形式を選択すればいいのか？ということを考えると、markdownは生き残りそうだ。あんまり聞いたことない形式なのに、どうしてそんなことが可能なのかといえば、それは、markdownがHTMLと互換性を持っているからということになる。HTMLとは、Web pageを記述するためのHyper-Text Markup Languageで、規格化されて情報社会のインフラになっているので永続性についてはかなり高いと考えられる。HTMLは文書の内容とその構造だけを書くための規格で、グラフィックスや動画、音声は外部ファイルを張り込むようになっている。markdownは、そのHTMLを簡単にしたものなので、同じ柔軟性を持っている。

　簡単に言ってみれば、Web pageに表現できるような構造化されて、いろいろなメディアを張り込んだ文書を最小限の手間で作れるようにした規格がmarkdown形式ということになる。Web pageが障害のある人たちにアクセシブルなので、markdownも同様の性質を引き継いでいる。

markdownで書くとどんないいことがあるの？

　具体的に、文書作成がどのくらい楽にできるのかということを示していく。まず、タイトルや、章の見出しという大事な文章に構造を与えるテキストをハッシュ記号「#」をつけることで簡単にタグづけできる。ハッシュ１つの後に書いたものは第１見出し、頭にハッシュ２つつけて書くと第２見出し、というだけ。

　HTMLみたいに、

<h1>タイトル</h1>

とか七面倒くさい、タイトルよりも文字数の多いタグづけをする必要がない！

　ワープロソフトでも、メニューにあるスタイルボタンから見出し１などと指定して書くのと同じことだが、キーボードから手を離してマウスやトラックパッドを使ってGUIを操作する必要はない。

　他にどんなトリックが使えるかというと、

　イタリックにしたいところは、半角アスタリスク「*」を１つイタリック部分の前後を囲む。

　強調したいところは、半角アスタリスク「*」を２つ並べて、強調部分の前後を囲めばいい。

　見え消しは、半角ティルダ「~」を２つ並べて、見え消ししたい部分の前後に置けばいい。

引用は、文頭に半角大なり記号「>」にスペースを置いて始める

• リストとかは半角マイナス記号「-」を1つで始めるとできる

  • 入れ子になってるリストも簡単にできるし

1. 数字付きリストとかは半角数字に半角ピリオドを繋いで始めるとできる

   1. 数字も入れ子になっていいし、

　文章を区切る横線は、半角マイナス記号「-」を3つ並べるだけ

---

　表は要素を半角縦線で区切ればできちゃうし（noteが対応していないので、これはnoteでは正しく表示されない）：

| a | b | c |
| ---- | ---- | ---- |
| 1 | 2 | 3 |

　外部URLへのリンクは、リンク先へのアンカー（クリックするとリンク先に飛ぶ部分のテキストのこと）を半角大括弧で囲った直後にURLをカッコで括ってつけると、東京ライトハウスの過去のnote みたいに書ける。

　で、書いてる最中にも見出しを使って文書内のナビゲーションができたりする。

　そして、これらがそれなりにnoteで再現できてるのは、noteがかなりmarkdownに対応しているからです。

　テキストで編集中に、マウス操作でレイアウトや構造を指定するのが、ワープロなどでの操作法の基本だけど、それだと、書いているときの思考の流れが止まってしまう。そして、これらは文章の構造情報を記録、HTMLでいうタグづけしているのと同じなので、HTMLやePubや、もちろんPDF、Word文書に変換・書き出しができる。構造をテキストと同じ感覚で、思考の流れのままに、キーボードで書き込めるというのは、慣れるときわめて効率がいい。

　そして、構造情報をもった文書というのは、機械にも情報を利用しやすい。AIに学習させる文書としても良いだろうし、スクリーンリーダーアプリで視覚障害の読者が文書を音声読み上げさせるときにも、見出しを飛ばしながら読むなどのことができて、見通しが良く使いやすい。同じことは、読書障害の人が利用するマルチメディア・リーダなどにも言える。つまり、いろいろなニーズのある読者に利用可能なユニバーサルな文書が、あんまり苦労せずに書けるということになる。テキストだけということは、出来上がりの文書が軽いということでもある。

　markdownじゃ、レイアウトされたプロな文書は作れないよね？それは、InDesignみたいな専用のレイアウトアプリに読み込んで完成させていくべきものです。markdownは構造だけ書くものだから、レイアウトはCSSみたいなもので記述して、棲み分けをしていくべきものでしょう。

ユニバーサルな文書ってどんなもの？

　視覚障害の読者のことを考えると、よく流通しているWord文書やPDFファイルなら読めるというのが現状の一般の理解かもしれない。しかし、PDFファイルには段組されていると読めないとか、改行の箇所がおかしくいとなんだかわかりにくいとか、そもそも文字情報が取り出せないとか、意外と課題が多い。アクセシビリティの高いPDFファイルと非常に低いPDFファイルの落差が大きい。Wordファイルも凝ったものはアクセスしにくい。もっともアクセシビリティに配慮されているのは、Web page、HTML形式と言えるだろう。markdownだけで書けるような、１段組で構造だけが付与されているような文書は、HTML文書と互換なので、アクセシビリティが良い。

　今後ユニバーサルな文書ファイルの主流は、WordやPDFからePubになっていくのかもしれないが、その場合もmarkdownは、そのePubに変換する前の文書を作成するための技術として、利用できるのではないかと思う。

　今、自分に障害がないという人も、高齢になれば、目も耳も衰えます。自分の知的生産の結果をずっと使いたければ、ユニバーサルで永続性の高い文書形式を覚えて、メインに利用していくことが賢明でしょう。だから、再利用可能でシンプルな構造的なテキストを書いて、メディアコンテンツやリンクを楽に組み込んだ書類を書く方法として、markdownを使い始めるのは、超おすすめです。

参考資料

Bailey, E. (2021) Improving The Accessibility Of Your Markdown https://www.smashingmagazine.com/2021/09/improving-accessibility-of-markdown/
alexwlchan (2021) Markdown’s gentle encouragement towards accessible images https://alexwlchan.net/2021/markdown-image-syntax/
Godfrey , A.J.R. (2016) Accessible R Markdown Documents https://r-resources.massey.ac.nz/rmarkdown/

文：小田浩一