Loading
Reorganize mkdocs.yml and update external scripts
概要
mkdocs.yml の設定を整理し,ドキュメントサイトのメタ情報・外部リソース・テーマ設定を最新化する.
項目の並びはZensicalのドキュメントを参考にした.
Closes #21 (closed)
変更内容
1. ヘッダー部分の整備
- 著作権表記,リポジトリ情報(
repo_name/repo_url/edit_uri)を追記 site_nameをFrontISTR→FrontISTR Documentationに変更site_url,site_descriptionを追加
2. 設定項目のアルファベット順への並べ替え
theme/featuresをアルファベット順に整理markdown_extensionsをアルファベット順に整理
3. 外部スクリプトの更新
- MathJax を v3 → v4 に更新
- tablesort を v5.3.0 → v5.7.1 に更新し,コメントアウトを解除して有効化
- サービス終了済みの
polyfill.ioを削除
4. theme/features に search.highlight を追加
検索ヒット箇所をハイライト表示する.
5. social リンクの整備
- GitLab アイコンとリンクを追加
- X(Twitter) アイコンとリンクを追加
- 既存の GitHub アイコンに
linkを付与
6. 項目の並び替え
Zensicalのドキュメントを参考に,mkdocs.yml 全体の項目順を整理.
区切りコメント(# Project information, # Repository, # Configuration, # Plugins, # Extensions など)を追加.
7. markdown_extensions に toc: permalink: true を追加
見出しにアンカーリンクを付与し,特定セクションへのリンク共有を容易にする.
動作確認
-
mkdocs serveでローカルビルドが成功すること - トップページのリポジトリリンク(GitLab)が正しく表示されること
- 各ページの「edit」リンクが正しいパスを指すこと
-
socialの GitLab / GitHub / X(Twitter) の各アイコン・リンクが動作すること - 数式(MathJax v4)が正しくレンダリングされること
- テーブルのソート(tablesort)が動作すること
- 検索結果のハイライト表示が動作すること
- 見出しのアンカーリンク(permalink)が表示・動作すること
Edited by inagaki