2018年12月21日

マークダウンでの脚注(注釈)は標準サポート外

マークダウンでの脚注(注釈)の扱いについて

単なるメモ書きです。

マークダウンにおいて、標準の記法では「脚注(注釈)」はサポートされていない、とのこと。 QiitaやPandocではサポートされているらしいが、「独自拡張」とのこと。

実際、markdown-it v8.4.0 ではサポートされていなかった。あと、VSCodeのプレビューでもサポート外だね^1。単なるリンク(無効)としてしか、表示されなかった。

標準の範囲で、「脚注」をエミュレートする方法としては、こんな方法がある。

ほげほげ[^1](#1)ふがふが
<span id="1" style="font-size:x-small">1: 注釈の内容</span>

以下のページを参考にした^2

1: VSCodeのマークダウン・プレビューは、markdown-itを用いるらしい。

2: 参考にしたサイトの記法からは、少し変更してある。私自身はQiitaっぽい記法が「そのままプレーンテキストに見える」(諸説あり)ので、こうしてみた。

蛇足:Markdownの目指すもの、とは?

そのまま「プレーンテキスト」として扱われなければならない、と。 へー、知らんかったよ。

A Markdown-formatted document should be publishable as-is, as plain text, without looking like it's been marked up with tags or formatting instructions.

Markdownで書かれた文書はプレーンテキストとして、そのままの形で発行されるべきである。 しかし、タグや整形のための指示によってマークアップされているように見えてはならない。 -- John Gruber

言われてみれば確かに、「そのままテキストとして扱える」ってのが、 私がマークダウンを気に入った理由だったね、そういえば。

でもどこかで「HTMLを簡単に記述するため」という目的もあったような???

参考サイト

posted by ほしまど at 20:32| Comment(0) | メモ書き
この記事へのコメント
コメントを書く
お名前:

メールアドレス:

ホームページアドレス:

コメント: