Introduction

Problem Statement

You want to create a documentation portal that has a good design, but you want to focus only on the content, not on the design itself. You also want this documentation portal to be updated automatically whenever you commit something to a GitHub repository.

Solution

Use MkDocs to create the documentation portal website. Publish the website using GitHub Pages. Automate updates using GitHub Actions.

See the tutorial

Click Step-by-step to go directly to the tutorial.

Learn more

Click on References to learn more about these tools.

Author

Silvia Z. Rocha
Github: https://github.com/szalbuque