Skip to main content

Default mkdocs theme for Duon projects

Project description

Duon MkDocs Theme

This is a theme for MkDocs which is mainly used for the documentation of Duon 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_duon-0.1.0.tar.gz (105.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_duon-0.1.0-py3-none-any.whl (104.1 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_duon-0.1.0.tar.gz.

File metadata

  • Download URL: mkdocs_duon-0.1.0.tar.gz
  • Upload date:
  • Size: 105.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.0

File hashes

Hashes for mkdocs_duon-0.1.0.tar.gz
Algorithm Hash digest
SHA256 48ef5b69adce5a1a7ff4ef66de1d9550d9b2ce98e241053b7f3bb09cd0a7da02
MD5 5fe634f0cc78f78d32b9f388dd647b28
BLAKE2b-256 5ebee1a5dd9330940425cb8b3db665b4d4de18d85258add7c66ab46544017980

See more details on using hashes here.

File details

Details for the file mkdocs_duon-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_duon-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 539450e5447d8230fc121eb04774ded92a0e1fcab780e7004eb0e7d41c8ae0c4
MD5 f820f3e8504069fe67c0d6ea78435105
BLAKE2b-256 f83868e1167569de886e5610e7ffe235032f030d472bda10ab3d6b65c9b505cd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page