Skip to content

Setup Guide

This page explains how to get started with this template.

Prerequisites

  • Python 3.8 or higher
  • Git

Installation

pip install -r requirements.txt

Configuration

Edit mkdocs.yml to customize your site:

site_name: My Awesome Project

Deployment

Simply push to main or master branch to trigger the GitHub Action.