Skip to content

MKDocs Template Documentation

A template for creating and deploying documentation using MKDocs, leveraging the Material theme for a clean and modern look. The included CI/CD pipeline facilitates seamless deployment to GitHub Pages.

Template Structure

  • mkdocs.yaml: Configuration file for MKDocs, defining the site's appearance, navigation, and deployment settings.
  • .github/workflows/: Contains the GitHub Actions workflow for automatic deployment.
  • docs/: Contains the markdown files, configuration files, and static assets that make up the documentation.
  • docs/.pages: Important file containing the nav definition for the site's navigation.
  • docs/requirements.txt: Lists the necessary Python packages.
  • docs/static/: Folder for static assets like logos and favicons.
  • docs/index.md: Defaults to referencing the projects README.md file.
  • (Other files like getting-started.md, faq.md etc.): Markdown files containing the actual documentation content.

Usage Instructions

The preferred way to use the template is through the tam-cli tool. This tool allows you to easily initialize a new project with a template.

Installation

pipx install git+https://github.com/DND-IT/tam-cli.git

Running

tam template init [REPO_NAME]

Follow the prompts to select the template.