mkdocs-rsoxs¶

A mkdocs theme for als rsoxs projects

Installation¶

Install using pip:

pip install mkdocs_rsoxs

Or using uv (recommended):

uv add mkdocs_rsoxs

Quick Start¶

import mkdocs_rsoxs

print(mkdocs_rsoxs.__version__)

Development¶

Prerequisites¶

• Python 3.13+
• uv for package management

Setup¶

Clone the repository and install dependencies:

git clone https://github.com/als-rsoxs/mkdocs-rsoxs.git
cd mkdocs-rsoxs
uv sync --group dev

Running Tests¶

uv run pytest

Code Quality¶

# Lint
uv run ruff check .

# Format
uv run ruff format .

# Type check
uv run ty check

Prek Hooks¶

Install prek hooks:

prek install

License¶

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.