This Blog🔗︎
A couple years ago, I stumbled upon Material for MkDocs. When the project added blog support last September, I became a sponsor and started authoring away. Now some 15 months later I'm finally getting around to configuring a proper build/deploy pipeline and actually getting this thing out the door. I've tried and abandoned personal blogging a number of times... hopefully, this time, it sticks.
I don't have much to share on how this site is hosted. I follow this almost to a T. One obvious difference is the use of a custom domain. I got caught up for a bit getting this to work.
Basically, I'd configure the domain name www.tlofreso.com at <my repo>/settings/pages --> Custom Domain. This worked, until I would push an update to the site... then my custom domain settings would disappear. GitHub requires a CNAME file, which existed, but in the wrong location.
MkDocs has a command line utility: mkdocs gh-deploy specifically built for the purpose of deploying your docs to GitHub Pages ( Great! ). The utility creates, and pushes a gh-pages branch to your repo, which is ultimately what serves the site. The CNAME file I'd created at project root did not exist in the gh-pages branch. I moved it to my docs_dir per the documentation.
| project_root/docs/CNAME | |
|---|---|
1 | |
Success!