Note
最新仕様は 用語集をyamlで書く（2026年最新版） を参照ください。
今回は用語集を書きたいと思います。
どうやって書く？
適当に探した感じだと、流行ってる用語集ツールは見当たらない感じでした。 （強いていうなら asciidoctor の定義リストがいいかなー。）
とはいえ今回もテキストベースで用語集を作っていきたい。
無いなら作ればええがな、ということで自分で作ることにします。
---
lang: ja
title: 用語集タイトル
description: 用語集の目的とか概要
date: 更新日
---
用語1: |
用語1の内容
用語2: http://hoge/ 用語2の内容
用語3: |
用語1を参照
仕様はこんな感じ。
- frontmatterに用語集自体のメタデータを記載
- 本文はYAMLのハッシュ。用語がハッシュのキーで、内容が値になる。もちろんブロックスタイルが使える。
- 用語に定義されている文字は全て収集し、ページ内リンクになる
- httpおよびhttpsから始まる文字はURLと見なして外部リンクになる
- 出力は1枚のhtml
実行
$ pip install ygloss
$ ygloss glossary.yaml > glossary.html
出力されるhtmlが気に入らない場合は、
cd $(which ygloss)
で移動した先のディレクトリにある tmpl.html を書き換えると良いです。
実装
詳細は こちら を参照。
https://github.com/yosiopp/ygloss