Material for MkDocs Template

Click Use this template for the quickest method of getting started with Material for MkDocs.

What's in this README?

A README is the starting point for anyone looking to learn more about a project on GitHub. The .md file format tells you that this file will be rendered in Markdown.

GitHub uses a special flavour of Markdown, called GitHub Flavoured Markdown.

This README will give you some practice with Markdown, and help you create your first MkDocs site.

Unfortunately, this README has very little Markdown in it. Before we get into MkDocs, let's improve the aesthetics in this file. While editing, you can toggle into Preview mode.

Getting Started

Important!!

In your newly created repository, complete the following:

1. Give GitHub Actions Read and write permissions on this repo Settings -> Actions -> General -> Workflow Permissions

2. Enable GitHub Pages Settings -> Pages -> Build & Deployment -> Source -> GitHub Actions

3. Change respository name Click on _config.yml -> Edit this file -> repository: -> (replace with your username/repository)

What's Included

Contains basic configuration to get you a repository with:

• MkDocs directory structure.
• Sample index page.
• Sample configuration file.
• Pre-configured GitHub Action.
• This wonderful README.

Checklist

• Set permissions on GitHub Actions
• Enable GitHub Pages
• Add content and webpages
• Enjoy my site!

Going Further

If you are working locally you can install Material for Mkdocs with pip, like so

pip install mkdocs-material

Those are a few of the basics, but there is lots more to explore. This is a great resource from GitHub

This material was developed by the RCDS team at ECRI.