How to deploy MkDocs to GitHub Pages¶
I'm using Obsidian + MkDocs + GitHub to make my notes public.
Getting started¶
- Create a new github repository
- Clone the repository into your Obsidian folder/vault.
-
Create mkdocs
bash cd repo-name mkdocs new .
-
Create or move your notes you would like to make public to the
repo-name/docs
- Create an empty branch on your GitHub repository
- On your GitHub reposito, go to
Settings > Pages
and select the select the Source as yourgh-pages
branch.
INFO - Copying '/home/runner/work/til/til/site' to 'gh-pages' branch and pushing to GitHub.
remote: Permission to dalekurt/til.git denied to github-actions[bot].
![[github-workflow-permissions.png]]
Last update: March 4, 2023