7rikazhexde’s tech log

技術的な興味関心、備忘録、アウトプットなどを書いています。

トップ > MkDocs

MkDocs

【Material for MkDocs】MkDocs Macros Pluginを使用した自作のカスタムリンクカードマクロについて

Material for MkDocs MkDocs Pytho SSG mkdocs-macros-plugin Link Card

背景 私はMaterial for MkDocsを使用して、技術系のTips記事をまとめたサイトを公開しています。 7rikazhexde-pkm-obsidian-mkdocs.netlify.app Material for MkDocsでは様々なプラグインや拡張機能が公開されていますが、上記のはてなブログのようなリンク…

#Material for MkDocs #Python #mkdocs-macros-plugin #Link Card

【Twitter Cards / OGP】mdformatでYAML Frontmatterが変換される現象と回避方法について

Material for MkDocs MkDocs mdformat YAML Frontmatter 備忘録 Twitter Cards OGP

経緯 以前、以下の記事でmkdocsで作成したドキュメントページをpre-commitでmdformatを使用した際にmkdocs(Admonitions)が意図した表示にならない問題と解決方法について投稿しました。 7rikazhexde-techlog.hatenablog.com 今回はtwitter cardに対応するた…

#Material for MkDocs #Mdformat #Frontmatter #Twitter Cards #OGP

Material for Mkdocsでgitリポジトリの追加で最新のリリース情報(タグ)を表示する方法

GitHub Material for MkDocs MkDocs 備忘録 REST API

経緯 表示内容 リリース作成前 リリース作成後 補足: REST APIによる確認 リリース作成前 リリース作成後 手順 リリースの作成(GitHub) リポジトリ設定 まとめ 経緯 Material for Mkdocsではヘッダーにgitリポジトリの情報を表示することができます。 squidf…

#MkDocs #Material for MkDocs #GitHub #REST API

【エラー解決方法】MkDocsで「mkdocs gh-deploy --force」を実行すると、「ERROR - Config value 'plugins': Plugin 'i18n' option 'languages': Expected a list of items, but a <class 'dict'> was given.」が発生し、GitHub Pagesへのデプロイに失敗する。

GitHub Actions GitHub Pages Material for MkDocs MkDocs 備忘録 エラー解決方法 mkdocs-static-i18n i18n

更新情報 20230902 20230923 概要 GitHub Actionの実行結果とエラー内容 使用中のYAMLファイル Runアクション(pip install) Runアクション(mkdocs gh-deploy --force) エラー内容 エラー解決方法 変更前のpyproject.toml パッケージのバージョン確認(poetry …

#MkDocs #i18n #GitHub Pages #GitHub Actions #Material for MkDocs

MkDocsで技術系Tipsを作成してGitHub Pagesで公開する

MkDocs Material for MkDocs GitHub Pages GitHub Actions GitHub Git Gist SSG 備忘録

注意事項 経緯 作成したページ GitHub Pagesへの公開までの流れ 静的サイトジェネレータ(SSG)の選択 基本構成と追加要素検討 フォルダ構成検討 スクリプト作成 1. pyprojtect.tomlのバージョン更新用スクリプト 2. git tag実行用スクリプト 3. pre-commit-ho…

#MkDocs #GitHub Actions #GitHub Pages #Material for MkDocs #SSG