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.

Team

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

Fernando Celmer
Fernando Celmer

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.

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.4.tar.gz (459.4 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_dracula_theme-1.0.4-py3-none-any.whl (465.0 kB view hashes)

Uploaded Python 3

Supported by

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