MkDocs環境の紹介

VRM Terminalは MkDocsと Material for Mkdocs で構築しています。

このページでは，VRM Terminalの構築に使っているMkDocs環境を紹介します。

MkDocsの概要

MkDocsは，Markdownで執筆した原稿をHTMLに仕立ててくれる静的サイトジェネレータです。デザインについては，サードパーティで豊富なテーマが多数公開されており，テーマカラーのカスタマイズ程度であれば難しくありません。 Material for Mkdocsは，Googleが提唱する「マテリアルデザイン」に基づくテーマで，いろいろなサイトで使われています。 VRMNXの公式マニュアルも使っていますね。

VRM Terminalの構築環境

Component	Version (2026.07)
OS	Windows 11
Editor	Visual Studio Code
Python	Python 3.10.7 (venv)
MkDocs	mkdocs 1.6.1
Material for MkDocs	mkdocs-material 9.7.6

このほか，Extensionがいくつか。

VRM Terminal構築用のPython環境（バージョン）を安定させるため， VS Code + venvでPython仮想環境を構築しています。

MkDocsのビルドコマンドもVS Codeに統合されているPowershellから叩けます。

コードブロック

今のMaterial for Mkdocsのバージョンでは，コードブロックの装飾も統合されています。 Ver. 9.5.3 時点の公式リファレンスを参考に設定しています。

mkdocs.yml

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

この方法（とバージョン）だと，行番号表示がずれません。表示領域をはみ出る場合には，スクロールバーが出てきます。（勝手に改行されない。）

```python linenums="1" title="LAYOUT"
import vrmapi
import toruo

def vrmevent(obj, ev, param):
    toruo.activate(obj, ev, param)
    # コメントを書いても大丈夫
    pass
```

LAYOUT
import vrmapi
import toruo

def vrmevent(obj, ev, param):
    toruo.activate(obj, ev, param)
    # コメントを書いても大丈夫
    pass

数式

MathJaxを導入し，数式の表示にも対応しています。

\[ ax^2 + b x + c = 0 \]