| Name | mkdocs-dracula-theme JSON |
| Version |
1.0.8
JSON |
| download |
| home_page | None |
| Summary | Dark theme for Mkdocs |
| upload_time | 2025-08-04 18:25:34 |
| maintainer | Fernando Celmer |
| docs_url | None |
| author | Fernando Celmer |
| requires_python | >=3.9 |
| license | MIT License
Copyright (c) 2024 Dracula Theme
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
mkdocs
dracula
theme
dark
documentation
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
mkdocs
mkdocs-dracula-theme
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Dracula for [Mkdocs](https://www.mkdocs.org/)
> A dark theme for [Mkdocs](https://www.mkdocs.org/).
## Install
### Installation MkDocs
To install MkDocs, run the following command from the command line:
```bash
pip install mkdocs
```
### Installation theme
Install the theme using PIP:
```bash
pip install mkdocs-dracula-theme
```
### Activating theme
After the theme is installed, edit your `mkdocs.yml` file and set the theme name to `dracula`:
```yml
theme:
name: dracula
```
All instructions can be found at [draculatheme.com/mkdocs](https://draculatheme.com/mkdocs).
### Changing the favicon
```yml
theme:
favicon: assets/favicon.ico
```
## Team
This theme is maintained by the following person(s) and a bunch of [awesome contributors](https://github.com/dracula/mkdocs/graphs/contributors).
| [](https://github.com/FernandoCelmer) | [](https://github.com/Ymil) |
| ------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
| [Fernando Celmer](https://github.com/FernandoCelmer) | [Lautaro Linquimán](https://github.com/Ymil) |
## Community
- [Twitter](https://twitter.com/draculatheme) - Best for getting updates about themes and new stuff.
- [GitHub](https://github.com/dracula/dracula-theme/discussions) - Best for asking questions and discussing issues.
- [Discord](https://draculatheme.com/discord-invite) - 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.
- 🐛 [Bug Report](https://github.com/dracula/mkdocs/issues/new/choose)
- 📕 [Documentation Issue](https://github.com/dracula/mkdocs/issues/new/choose)
- 🚀 [Feature Request](https://github.com/dracula/mkdocs/issues/new/choose)
- ⚠️ [Security Request](https://github.com/dracula/mkdocs/issues/new/choose)
- 💬 [General Question](https://github.com/dracula/mkdocs/issues/new/choose)
## Commit Style
- ⚙️ FEATURE
- 📝 PEP8
- 📌 ISSUE
- 🪲 BUG
- 📘 DOCS
- 📦 PyPI
- ❤️️ TEST
- ⬆️ CI/CD
- ⚠️ SECURITY
## License
[MIT License](./LICENSE)
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocs-dracula-theme",
"maintainer": "Fernando Celmer",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "email@fernandocelmer.com",
"keywords": "mkdocs, dracula, theme, dark, documentation",
"author": "Fernando Celmer",
"author_email": "email@fernandocelmer.com",
"download_url": "https://files.pythonhosted.org/packages/d4/6e/a0fa20a34e9bb6194a0668a3f9ecf2b2e00b6204526ec64ff6ee96368cf9/mkdocs_dracula_theme-1.0.8.tar.gz",
"platform": null,
"description": "# Dracula for [Mkdocs](https://www.mkdocs.org/)\n\n> A dark theme for [Mkdocs](https://www.mkdocs.org/).\n\n\n\n## Install\n\n### Installation MkDocs\n\nTo install MkDocs, run the following command from the command line:\n\n```bash\npip install mkdocs\n```\n\n### Installation theme\n\nInstall the theme using PIP:\n\n```bash\npip install mkdocs-dracula-theme\n```\n\n### Activating theme\n\nAfter the theme is installed, edit your `mkdocs.yml` file and set the theme name to `dracula`:\n\n```yml\ntheme:\n name: dracula\n```\n\nAll instructions can be found at [draculatheme.com/mkdocs](https://draculatheme.com/mkdocs).\n\n### Changing the favicon\n\n```yml\ntheme:\n favicon: assets/favicon.ico\n```\n\n## Team\n\nThis theme is maintained by the following person(s) and a bunch of [awesome contributors](https://github.com/dracula/mkdocs/graphs/contributors).\n\n| [](https://github.com/FernandoCelmer) | [](https://github.com/Ymil) |\n| ------------------------------------------------------------------------------------------------------- | --------------------------------------------- |\n| [Fernando Celmer](https://github.com/FernandoCelmer) | [Lautaro Linquim\u00e1n](https://github.com/Ymil) |\n\n## Community\n\n- [Twitter](https://twitter.com/draculatheme) - Best for getting updates about themes and new stuff.\n- [GitHub](https://github.com/dracula/dracula-theme/discussions) - Best for asking questions and discussing issues.\n- [Discord](https://draculatheme.com/discord-invite) - Best for hanging out with the community.\n\n## Getting Help\n\nWe 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.\n\n- \ud83d\udc1b [Bug Report](https://github.com/dracula/mkdocs/issues/new/choose)\n- \ud83d\udcd5 [Documentation Issue](https://github.com/dracula/mkdocs/issues/new/choose)\n- \ud83d\ude80 [Feature Request](https://github.com/dracula/mkdocs/issues/new/choose)\n- \u26a0\ufe0f [Security Request](https://github.com/dracula/mkdocs/issues/new/choose)\n- \ud83d\udcac [General Question](https://github.com/dracula/mkdocs/issues/new/choose)\n\n## Commit Style\n\n- \u2699\ufe0f FEATURE\n- \ud83d\udcdd PEP8\n- \ud83d\udccc ISSUE\n- \ud83e\udeb2 BUG\n- \ud83d\udcd8 DOCS\n- \ud83d\udce6 PyPI\n- \u2764\ufe0f\ufe0f TEST\n- \u2b06\ufe0f CI/CD\n- \u26a0\ufe0f SECURITY\n\n## License\n\n[MIT License](./LICENSE)\n\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2024 Dracula Theme\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "Dark theme for Mkdocs",
"version": "1.0.8",
"project_urls": {
"Changelog": "https://dracula.github.io/mkdocs/nav/development/release-notes",
"Documentation": "https://dracula.github.io/mkdocs",
"Homepage": "https://draculatheme.com/mkdocs",
"Issues": "https://github.com/dracula/mkdocs/issues",
"Repository": "https://github.com/dracula/mkdocs"
},
"split_keywords": [
"mkdocs",
" dracula",
" theme",
" dark",
" documentation"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "04ba39fa5ac5017caedca6bd9d722cf451597b0d4ff6e6cc5b0e735892ff2a42",
"md5": "31ece4951365c426c1ef7ea5316fab50",
"sha256": "bea486ec581792ae7eb2de3ec70c729df9740b56c552654cf38bcdb0979cbe37"
},
"downloads": -1,
"filename": "mkdocs_dracula_theme-1.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "31ece4951365c426c1ef7ea5316fab50",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 465211,
"upload_time": "2025-08-04T18:25:33",
"upload_time_iso_8601": "2025-08-04T18:25:33.303314Z",
"url": "https://files.pythonhosted.org/packages/04/ba/39fa5ac5017caedca6bd9d722cf451597b0d4ff6e6cc5b0e735892ff2a42/mkdocs_dracula_theme-1.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d46ea0fa20a34e9bb6194a0668a3f9ecf2b2e00b6204526ec64ff6ee96368cf9",
"md5": "3747459047357e842ec94ac45225bc9d",
"sha256": "5da6e9b118e3379b5591780ade6e8ad9f3d8ac70c28e50e7fd2a4548670581e5"
},
"downloads": -1,
"filename": "mkdocs_dracula_theme-1.0.8.tar.gz",
"has_sig": false,
"md5_digest": "3747459047357e842ec94ac45225bc9d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 458668,
"upload_time": "2025-08-04T18:25:34",
"upload_time_iso_8601": "2025-08-04T18:25:34.369229Z",
"url": "https://files.pythonhosted.org/packages/d4/6e/a0fa20a34e9bb6194a0668a3f9ecf2b2e00b6204526ec64ff6ee96368cf9/mkdocs_dracula_theme-1.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-04 18:25:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dracula",
"github_project": "mkdocs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "mkdocs",
"specs": [
[
"==",
"1.5.3"
]
]
},
{
"name": "mkdocs-dracula-theme",
"specs": [
[
"==",
"1.0.7"
]
]
}
],
"lcname": "mkdocs-dracula-theme"
}
