MKDocsで絵文字を使ってみる

はじめに

この記事では、「MKDocsで絵文字を使う方法」について書いています。

MKDocsはmarkdownからWebサイトのような構成のドキュメントを作ることができる非常に便利なツールです。

このMKDocsで絵文字を使うことができないのかなぁとなったのが記事を書いたきっかけでした。

自分に向けた備忘録でもありますが、「MKDocsで絵文字を使いたい」な人の一助になれば嬉しいです。

実際に試してみる

MKDocsで絵文字を使用する場合は、mkdocs.ymlに絵文字を使うために以下の設定を追加します。

markdown_extensions:
    - pymdownx.emoji:
        emoji_generator: !!python/name:pymdownx.emoji.to_alt

例えば以下のように書きます。

site_name: My Docs

theme:
  name: 'mkdocs'

markdown_extensions:
    - pymdownx.emoji:
        emoji_generator: !!python/name:pymdownx.emoji.to_alt

この設定で実際にMKDocsで絵文字が表示されるのか確認してみましょう。

index.mdに絵文字を表示するために以下の記述を追加します。

## Test

:smile:

:smile:が絵文字を表示するためのコードです。

さて、これで実際に表示させてみた結果が下の画像になります。

Testの項の部分に絵文字が表示されています。

おわりに

「MKDocsで絵文字を使う方法」について解説しました。

MKDocsはドキュメントを作るツールとしてとても便利ですので、是非使い方を覚えて活用してみてはいかがでしょうか。

さいごに、記事を書く上で参考にしたサイトのリンクを以下に掲載します。合わせて読んでいただくと良いかと思います。

zenn.dev