Hatena Blog Tags
はてなブログ トップ
MkDocs
このタグでブログを書く

MkDocs

このタグの解説についてこの解説文は、すでに終了したサービス「はてなキーワード」内で有志のユーザーが作成・編集した内容に基づいています。その正確性や網羅性をはてなが保証するものではありません。問題のある記述を発見した場合には、お問い合わせフォームよりご連絡ください。
7rikazhexde’s tech log•2年前

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

経緯 表示内容 リリース作成前 リリース作成後 補足: REST APIによる確認 リリース作成前 リリース作成後 手順 リリースの作成(GitHub) リポジトリ設定 まとめ 経緯 Material for Mkdocsではヘッダーにgitリポジトリの情報を表示することができます。 squidfunk.github.io 公式ドキュメントを見るとわかりますが、latest releaseとstars,forksの情報が表示されていますが、私の環境ではリポジトリの設定をしてもlatest releaseの情報は表示されませんでした。 調べると公式ドキュメントの脚注に以下の記載がありました。つま…

#MkDocs#Material for MkDocs#GitHub#REST API

関連ブログ

7rikazhexde’s tech log•2年前

【エラー解決方法】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へのデプロイに失敗する。

更新情報 20230902 20230923 概要 GitHub Actionの実行結果とエラー内容 使用中のYAMLファイル Runアクション(pip install) Runアクション(mkdocs gh-deploy --force) エラー内容 エラー解決方法 変更前のpyproject.toml パッケージのバージョン確認(poetry show) 変更後のpyproject.toml mkdocs-static-i18nの更新 更新後のビルド確認 mkdocs.ymlの更新 再ビルドでWARNING まとめ 更新情報 20230902 下記手順を確認したところ、プロジェクト直下のi…

#MkDocs#i18n#GitHub Pages#GitHub Actions#Material for MkDocs
7rikazhexde’s tech log•2年前

mdformat + mkdocs(Admonitions)で意図した表示にならない現象と解決方法について

背景 発生した現象について OKケース NGケース 解決方法 注意点 使用方法 補足: 個別にmdformatを使用する場合 1. pre-commitフックで個別にmdformatする場合 2. 未ステージング状態のファイルに対してもフックを実行する場合 補足: その他フォーマッターとの差異について まとめ 背景 以前以下の記事でMkdocsについて紹介しました。 7rikazhexde-techlog.hatenablog.com 記事の中では言及していなかったのですが、私はMarkdown用のフォーマッターとしてmdformatを使用しています。 公式ドキュメント: mdformat.r…

#MkDocs#Mdformat#Material for MkDocs
7rikazhexde’s tech log•2年前

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

注意事項 経緯 作成したページ GitHub Pagesへの公開までの流れ 静的サイトジェネレータ(SSG)の選択 基本構成と追加要素検討 フォルダ構成検討 スクリプト作成 1. pyprojtect.tomlのバージョン更新用スクリプト 2. git tag実行用スクリプト 3. pre-commit-hooksの指定id毎のexclude追加用スクリプト コード 処理のポイント 4. mkdocs buildコマンド実行用スクリプト コード 処理のポイント GitHub Actionsの設定とmkdocs.ymlの作成 .github/workflows/push_gh-deploy.ym…

#MkDocs#GitHub Actions#GitHub Pages#Material for MkDocs#SSG
気ままに技術勉強ブログ•3年前

MkDocsで脚注を付けてみる

はじめに この記事では、「MkDocsで脚注を付ける方法」について書いています。 MkDocsでドキュメントを書くことが最近多いのですが、その使い方を色々調べる中で「知ってたら便利そう」な小ネタを知ったのが記事を書いたきっかけでした。 自分に向けた備忘録でもありますが、「MkDocsで注釈を付けたい、その方法が知りたい」な人の一助になれば嬉しいです。 注釈の付け方 mkdocs.ymlに以下の記述を加えます。 markdown_extensions: - footnotes 下に簡単な例を出すとこんな感じになります。 site_name: My Docs theme: name: 'mkdoc…

#MkDocs
気ままに技術勉強ブログ•3年前

MKDocsで絵文字を使ってみる

はじめに この記事では、「MKDocsで絵文字を使う方法」について書いています。 MKDocsはmarkdownからWebサイトのような構成のドキュメントを作ることができる非常に便利なツールです。 このMKDocsで絵文字を使うことができないのかなぁとなったのが記事を書いたきっかけでした。 自分に向けた備忘録でもありますが、「MKDocsで絵文字を使いたい」な人の一助になれば嬉しいです。 実際に試してみる MKDocsで絵文字を使用する場合は、mkdocs.ymlに絵文字を使うために以下の設定を追加します。 markdown_extensions: - pymdownx.emoji: emoj…

#MkDocs
気ままに技術勉強ブログ•3年前

MKDocsでURLを書いたら自動でハイパーリンクさせてみる

はじめに この記事では、「MKDocsでURLを書いたら自動でハイパーリンクさせる方法」について書いています。 MKDocsでドキュメントを書くことが最近多いのですが、その使い方を色々調べる中で「知ってたら便利そう」な小ネタを知ったのが記事を書いたきっかけでした。 自分に向けた備忘録でもありますが、「MKDocsでURLを書いたら自動でハイパーリンクさせたい」な人の一助になれば嬉しいです。 要点だけ ymlファイルに以下を追加する markdown_extensions: - pymdownx.magiclink 実際に試してみる まずは、特に気にせず以下のようにymlファイルを書いた際、UR…

#MkDocs
気ままに技術勉強ブログ•3年前

MKDocsで数式を表示するためにKaTeXを使えるようにしてみる

はじめに この記事では、「MKDocsでKaTeXを用いて数式表示をする方法」について書いています。 MKDocsで数式も書けると使える場面が増えて便利だなと調べ、以前に紹介しました。 更に調べたところ、以前に紹介したものはMathJaxというエンジンを用いたもので、他にもKaTexというエンジンを用いてMKDocs上で数式を書く方法もあることが分かったので導入の仕方を調べ実際に試してみた結果を記事にしてみました。 自分に向けた備忘録でもありますが、「MKDocsで数式を表示したい」や「MKDocsでKaTeXを使いたい」な人の一助になれば嬉しいです。 要点だけ pip install mar…

#MkDocs#KaTeX
気ままに技術勉強ブログ•3年前

MKDocsで数式を書く方法

はじめに この記事では、「MKDocsで数式を書く方法」について書いています。 最近MKDocsを使って資料を書く機会が多いのですが、数式を扱うことがある人なら、MKDocsで数式を書けると便利かと思います。 自分に向けた備忘録でもありますが、「MKDocsで数式を書きたい」な人の一助になれば嬉しいです。 本文 今、以下の数式（何が表示されるかは後ほど分かります）をMKDocsで表示させたいとします。 $$ \int^{b}_{a} f(x) dx $$ まずは何もしてない状態で、ymlファイルは以下のような記述です。 site_name: My Docs theme: name: 'mkdo…

#MkDocs
気ままに技術勉強ブログ•3年前

MKDocsでMermaidを使う方法

はじめに この記事では、「MKDocsでMermaidを使う方法」について書いています。 最近MKDocsを使って資料を書く機会が多いのですが、テキストで様々な図表を書くことができるMermaidをMKDocsで使いたいときはどうするのだろうと思ったのが記事を書いたきっかけでした。 自分に向けた備忘録の意味もありますが、「MKDocsでMermaidを使ってみたい」な人の一助になれば嬉しいです。 要点だけ ymlファイルに以下の記述を足してください site_name: My Docs theme: name: 'material' markdown_extensions: - pymdown…

#MkDocs#Mermaid