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.9.dev1.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.9.dev1-py3-none-any.whl (465.3 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_dracula_theme-1.0.9.dev1.tar.gz.

File metadata

File hashes

Hashes for mkdocs_dracula_theme-1.0.9.dev1.tar.gz
Algorithm Hash digest
SHA256 e17254ef54225f3ae3581d9c00a0d358b536dd75a9c37dfc8e0eff34534263db
MD5 d0557160fe4fdc6bca0c45b910091bce
BLAKE2b-256 a8ee267f2adaea1f0adbaa4d7980430d9ccf905d03c602d302e73461c0f77dbd

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_dracula_theme-1.0.9.dev1.tar.gz:

Publisher: python-publish-pypi.yml on dracula/mkdocs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mkdocs_dracula_theme-1.0.9.dev1-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_dracula_theme-1.0.9.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 c4691a416f202845865d9e47a1c6a3e22aee24659420e14a1885ef5060f2c17b
MD5 ae414d4a2d069e1411a8e450345fe274
BLAKE2b-256 e20a7ae1d5d4c1c72f77953b6aedf4327b0170d64251aaa3347bca70682cf195

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_dracula_theme-1.0.9.dev1-py3-none-any.whl:

Publisher: python-publish-pypi.yml on dracula/mkdocs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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