InlineHilite 拡張機能

インラインコード要素にシンタックスハイライトをつけます


taiseiue | 2024-11-21

対応バージョン:>=2.12

概要

InlineHilite拡張機能を使うと、Markdownのインラインコードに、シンタックスハイライトをつけることができます。

段落中で、`:::language code`と書くことで、コードにlanguageに対応したインラインハイライトがつきます。

この構文は、PyMdown Extensionsによって実装されます。 構文の詳細については、InlineHilite - PyMdown Extensions Documentationをご覧ください。

Markdown
Pythonでモジュールを読み込むには、`:::py3 import`文を使います。
例えば、`sys`モジュールを読み込むには、`:::py3 import sys`と書きます。

結果

Pythonでモジュールを読み込むには、import文を使います。 例えば、sysモジュールを読み込むには、import sysと書きます。

導入方法

サイト内のmkdocs.ymlに、次の行を追加します。

mkdocs.yml
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences