LoginSignup
1
2

Qiitaの脚注は任意の文字列で指定できる。

Last updated at Posted at 2019-04-09

概要

  • 完全に自分用記事です QiitaというよりMarkdownの仕様のはなしかも。
  • Qiitaの記事に脚注を入れるとき、[^1]のように数字じゃなくても[^foot-note]のような文字列で指定できた。
  • 他の記事でも出てるんですが
    • Markdownの他の記法と一緒に書いてあるので、辿り着きにくかった。
    • 単純に「Qiita 脚注」でぐぐった際のトップに出てくる「この記事」だと数字の例しかないので気づけなかった。1

脚注に対する勘違いと混乱

もう概要で書いちゃいましたね。
Qiitaで使うMarkdownにおいて、脚注を入れる際にこんなサンプルがよく見られます。

脚注を入れたい
脚注についてのサンプルです。[^1]
記事中に余談を書くのは邪魔だから脚注で補足入れたい。時ありますよね。[^2]
[^1]: サンプルなので適当な文です
[^2]: 脚注が多い文章も困りものですが

しかし、この\[^1]\[^1]:のような連番による注釈は記事をアップデートする際の管理が大変です。間に文章を差し込んだときにそこに入れる脚注の番号はどうすればいいでしょうか?こんな風にだんだん混乱して来ます。

文を追加したいけど脚注どうしよう
脚注についてのサンプルです。[^1]
あとから文を差し込みたい時もありますよね。[^3]
記事中に余談を書くのは邪魔だから脚注で補足入れたい。時ありますよね。[^2]
[^1]: サンプルなので適当な文です
[^2]: 脚注が多い文章も困りものですが
[^3]: 差し込んだ脚注です

上のように書いても表示上は数字に関係なく出現順に1、2、3の連番で並びます。 見た目は不自然なく見えるんですが、管理はつらい。2
しかしこの脚注、実はこんな風に書けます。

脚注に名前を付けて管理する
脚注についてのサンプルです。[^sample]
あとから文を差し込みたい時もありますよね。[^sashikomi]
記事中に余談を書くのは邪魔だから脚注を入れたい。時ありますよね。[^arimasu]
[^sample]: サンプルなので適当な文です
[^sashikomi]: 差し込んだ脚注です
[^arimasu]: 脚注が多い文章も困りものですが

このほうが解りやすくなりますね。この方法で積極的に使っていきたいです。
この記事でも使っているので、この記事のMarkdownも参考にしてもらえればと思います。

それでも忘れちゃいけない大事なこと

あまり長い記事を書かない。
いわゆるTL;DRですが、読まれないだけじゃなくて記事をメンテしていくのも大変です。3

  1. 検索エンジンのトップに出る記事って重要ですよね…本格的に調べてることなら何件も探すけど、ちょっとしたことだと「あったあった、これでいいや」ってなる。その結果ちょっと不便なことに後で気づく。

  2. 最低限、脚注の本体は出現順に並べた方が楽だと思います。

  3. 最初に意識したのは「Keep It Simple. Stupid.」って言葉ですね。

1
2
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
2