Recently I wanted to migrate the documentation of my C# WordPress library WordPressPCL from the GitHub wiki to something more flexible. With version 2 of the libaray coming soon the idea was to move all the docs into a static site hosted with GitHub Pages and managed in Markdown files. Luckily with mkdocs it’s pretty straight forward to get this up-and-running quickly.
Here’s what I wanted:
- Docs as markdown files in main repository with readthedocs theme
- Automatic build of the static website using GitHub Actions
- Deployment of static website to GitHub Pages