Material for MkDocs is a theme for MkDocs. MkDocs is a static site generator intended to documenting projects.

With Material for MkDocs, you create your website using Markdown language and have access to several features, including a search bar.

This repository groups my experiences with Material for MkDocs and (possibliy) other static site generators.

The project in the main branch is based on James Willett's excellent tutorial on setting Material for MkDocs.

You can check the result at https://gabrielcostasilva.github.io/doc-mkdocs/

1. Ensure Python is installed and working.
2. Create a folder and go into it.
3. Create a virtual environment with:

python -m venv venv
source venv/bin/activate

4. Install MkDocs with: pip install mkdocs-material
5. Create a website project with: mkdocs new .
6. Run your website locally with: mkdocs serve
7. Customise your configuration at your will, then build your website for deployment with: mkdocs build

To build the website, I used documentation from several repositories on my Github account.

James Willett's tutorial teaches how to deploy to Github sites. But can also deploy your static website on Amazon S3. Checkout this video to find out how.

• AWS Copilot CLI
• AWS Lambda Powertools for Python