MKDocsでURLを書いたら自動でハイパーリンクさせてみる
はじめに
この記事では、「MKDocsでURLを書いたら自動でハイパーリンクさせる方法」について書いています。
MKDocsでドキュメントを書くことが最近多いのですが、その使い方を色々調べる中で「知ってたら便利そう」な小ネタを知ったのが記事を書いたきっかけでした。
自分に向けた備忘録でもありますが、「MKDocsでURLを書いたら自動でハイパーリンクさせたい」な人の一助になれば嬉しいです。
要点だけ
ymlファイルに以下を追加する
markdown_extensions: - pymdownx.magiclink
実際に試してみる
まずは、特に気にせず以下のようにymlファイルを書いた際、URLがどう表示されるかを見てみます。
site_name: My Docs theme: name: 'mkdocs'
画像の「Test」の項を見てください。
URLの文字列が表示されただけでハイパーリンクはされてなく、そこをクリックしてもURL先にアクセスするようなことはありません。
では次はymlファイルに記述を追加してハイパーリンクされるようにしてみましょう
site_name: My Docs theme: name: 'mkdocs' markdown_extensions: - pymdownx.magiclink
追加したのは下の2行です。この記述をすることでURLの文字列を自動でハイパーリンクしてくれるようになります。
実際にビルドし表示させた結果は下の画像です。
先程はハイパーリンクされてませんでしたが、記述追加後はちゃんとハイパーリンクされていることが分かるかと思います。
おわりに
「MKDocsでURLを書いたら自動でハイパーリンクさせる方法」について解説しました。
ちょっとした小ネタですが、知っておくと便利かもしれません。
さいごに、記事を書く上で参考にしたサイトのリンクを以下に掲載します。合わせて読んでいただくと良いかと思います。