Schlagwort: mkdocs

Documentation in GitHub Pages with mkdocs & readthedocs Theme

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:

  1. Docs as markdown files in main repository with readthedocs theme
  2. Automatic build of the static website using GitHub Actions
  3. Deployment of static website to GitHub Pages
Documentation in GitHub Pages with mkdocs & readthedocs Theme weiterlesen