Skip to main content

Dark theme for Mkdocs

Project description

Dracula for Mkdocs

A dark theme for Mkdocs.

Screenshot

Install

Installation MkDocs

To install MkDocs, run the following command from the command line:

pip install mkdocs

Installation theme

Install the theme using PIP:

pip install mkdocs-dracula-theme

Activating theme

After the theme is installed, edit your mkdocs.yml file and set the theme name to dracula:

theme:
    name: dracula

All instructions can be found at draculatheme.com/mkdocs.

Changing the favicon

theme:
  favicon: assets/favicon.ico

Team

This theme is maintained by the following person(s) and a bunch of awesome contributors.

Fernando Celmer Lautaro Linquimán
Fernando Celmer Lautaro Linquimán

Community

  • Twitter - Best for getting updates about themes and new stuff.
  • GitHub - Best for asking questions and discussing issues.
  • Discord - Best for hanging out with the community.

Getting Help

We use GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them. If you need anything, I ask you to please follow our templates for opening issues or discussions.

Commit Style

  • ⚙️ FEATURE
  • 📝 PEP8
  • 📌 ISSUE
  • 🪲 BUG
  • 📘 DOCS
  • 📦 PyPI
  • ❤️️ TEST
  • ⬆️ CI/CD
  • ⚠️ SECURITY

License

MIT License

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_dracula_theme-1.0.8.tar.gz (458.7 kB view details)

Uploaded Source

Built Distribution

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

mkdocs_dracula_theme-1.0.8-py3-none-any.whl (465.2 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_dracula_theme-1.0.8.tar.gz.

File metadata

  • Download URL: mkdocs_dracula_theme-1.0.8.tar.gz
  • Upload date:
  • Size: 458.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for mkdocs_dracula_theme-1.0.8.tar.gz
Algorithm Hash digest
SHA256 5da6e9b118e3379b5591780ade6e8ad9f3d8ac70c28e50e7fd2a4548670581e5
MD5 3747459047357e842ec94ac45225bc9d
BLAKE2b-256 d46ea0fa20a34e9bb6194a0668a3f9ecf2b2e00b6204526ec64ff6ee96368cf9

See more details on using hashes here.

File details

Details for the file mkdocs_dracula_theme-1.0.8-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_dracula_theme-1.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 bea486ec581792ae7eb2de3ec70c729df9740b56c552654cf38bcdb0979cbe37
MD5 31ece4951365c426c1ef7ea5316fab50
BLAKE2b-256 04ba39fa5ac5017caedca6bd9d722cf451597b0d4ff6e6cc5b0e735892ff2a42

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