Metadata-Version: 2.4
Name: mkdocs-duon
Version: 0.1.0
Summary: Default mkdocs theme for Duon projects
Home-page: https://github.com/duoncode/mkdocs-theme
Author: ebene fünf GmbH
Author-email: duon@ebenefuenf.de
License: MIT
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: mkdocs>=1.6
Requires-Dist: mkdocs-macros-plugin>=0.7
Requires-Dist: pymdown-extensions>=10.3
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

Duon MkDocs Theme
=====================

This is a theme for MkDocs which is mainly used for the documentation of
[Duon](https://duon.sh) projects 

## Installation

Install the package from PyPi using `pip`:

    pip install mkdocs-duon

Add the theme to your `mkdocs.yml` file:

    theme:
        name: duon

## Development server

    mkdocs serve -w theme   

## Styles

Install Dart Sass via `npm install -g sass`. During develompment:

    sass --watch styles:theme

## Deploy to PyPi

Install `uv` if not already done. Bump version number in
`setup.py`, then:

    git tag -a X.X.X -m "Release Version X.X.X"
    git push origin vX.X.X
    sass --style=compressed --no-source-map styles:theme
    uv build
    uv publish --username <user> --token <token> # or uv-publish with .pypirc
