How to install MkDocs on Mac and setup the integration to GitHub pages?

This blog post contains the simplified steps, how to setup MkDocs for a GitHub project to use it with GitHub Pages. I won’t covering details about the background. The blog post is for me a little cheat sheet and maybe it is also useful for you. Steve Martinelli created an awesome blog post in that context called 5 Features I Like About Material for MkDoc.

Here an example GitHub project, which is based on the setup I documented in this blog post:

The gif shows the example project documentation:

Continue reading

Get started with GitBook and GitHub a small guide

In this blog post I want to point out the great documentation topic GitBook.

The first time I noticed GitBook, was in a hands-on workshop, when I asked the presenters how they create and update their good looking workshop documentation.

I directly tried out the free GitBook version  for one of my GitHub projects and I noticed the awesome navigation, search, feedback and the responsive webpage capabilities which is all provided out of the box by GitBook. That’s awesome.

Here is a small gif that shows the GitHub page and the GitBook page at the same time.


Sure there are many more functionalities in GitBook such as teaming, but to use these functionalities you need a paid license and I didn’t tried that out.

Here is a small “get started guide” I created from my perspective to get started with a GitBook page.

Continue reading