昨今、技術界隈でもポリコレが重要視されている気がする世の中です. GitHubのデフォルトブランチがmainブランチに変更されていますが、MkDocsではmasterブランチがデフォルトのままです. この場合、生成されたHTMLの編集リンクはmasterブランチが参照されるため、GitHubで管理されている場合は404ページが表示されてしまいます.
そこで今回は、MkDocsでmainブランチの編集画面を開く設定を書いておきます.
TL; DR
- mkdocs.ymlに
edit_uri: edit/main/docs/を追記する
mainブランチの編集画面を開く
公式ドキュメントのedit_uriが今回利用する設定になります. 他の設定値よりも色々と書かれていますが、GitHubで管理しているリポジトリがmainブランチという前提で話を勧めているのため、
の部分を参考にしてedit_uriを追記します.
On GitHub and GitLab, the default "edit" path (edit/master/docs/) opens the page in the online editor.
GitHubとGitLabは、edit_uriにedit/master/docs/がデフォルトで設定されるということが分かります.
というわけで、値のmaster部分をmainに変更して値をmkdocs.ymlに追記すればOKです.
以下がその例です.
site_name: In Docs - MkDocs Prj Templates repo_url: https://github.com/corrupt952/mkdocs-prj-templates # これを追記 edit_uri: edit/main/docs/
