MkDocs Template

Important

Pleased note this repository is a template for creating a new repository. It is not intended to be used directly. Please dont dump random content here as it will be overwritten. While working on our KB refactor this template is used for work in progress and testing.

---

Caution

Also this repo must be public just for now so be careful what is added to it!

[[toc]]

Default Deployment Location

View doc output here:

https://<username>.github.io/<repository-name>

https://cellocommunications.github.io/mkdocs-template-enterprise/

Private Pages Configuration

Configure GitHub Pages for private access, restricting it to organization members only.

privacy

Workflow Concepts

Workflow concepts for managing documentation with GitHub Pages with more advanced features.

workflows

CoPilot Instructions

Your Copilot preferences are set via concise plain language instructions here.

copilot

Prerequisites

Installing UV

Before running the documentation server, you need to install uv - the extremely fast Python package manager. Choose the installation method for your operating system:

macOS and Linux

Using the standalone installer:

curl -LsSf https://astral.sh/uv/install.sh | sh

Alternatively, with Homebrew:

brew install uv

Windows

Using the standalone installer:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Alternatively, with WinGet:

winget install --id=astral-sh.uv -e

Other installation methods

You can also install with pipx (works on all platforms):

pipx install uv

For more installation options and detailed instructions, see the official documentation.

Local Development

Running the documentation server locally

Start the MkDocs development server with a single command:

uv run mkdocs serve

This command:

• Creates a Python virtual environment (if it doesn't exist)
• Installs all dependencies from pyproject.toml
• Starts the MkDocs server in development mode

When the server is running, you can view the documentation at http://127.0.0.1:8000/