# 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).
## 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)
- 💬 [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": "https://github.com/dracula/mkdocs",
"name": "mkdocs-dracula-theme",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Fernando Celmer",
"author_email": "email@fernandocelmer.com",
"download_url": "https://files.pythonhosted.org/packages/5b/8d/f78f53f0cd6c6d2d349453f0b7a002e09d72360612887df7ea4045b012cf/mkdocs-dracula-theme-1.0.7.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## 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- \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",
"bugtrack_url": null,
"license": "",
"summary": "\ud83e\udddb\ud83c\udffb\u200d\u2642\ufe0f Dark theme for Mkdocs",
"version": "1.0.7",
"project_urls": {
"Homepage": "https://github.com/dracula/mkdocs"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6a59ebd1af74acd20ada10126be3af60bd37c4dd2fa7065917b57290ced543ff",
"md5": "ca2d2f48cc426df5b8fb83b4e189e6ff",
"sha256": "cb9a6bb7d9d6a958b1a4e7a0e55ba25fd25291cafe284ce3a4307bc609530855"
},
"downloads": -1,
"filename": "mkdocs_dracula_theme-1.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca2d2f48cc426df5b8fb83b4e189e6ff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 466048,
"upload_time": "2024-01-17T03:06:37",
"upload_time_iso_8601": "2024-01-17T03:06:37.029661Z",
"url": "https://files.pythonhosted.org/packages/6a/59/ebd1af74acd20ada10126be3af60bd37c4dd2fa7065917b57290ced543ff/mkdocs_dracula_theme-1.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5b8df78f53f0cd6c6d2d349453f0b7a002e09d72360612887df7ea4045b012cf",
"md5": "d9009b93683bf60b91916523428c7836",
"sha256": "fee49784a04b1d8432cd026edcd5333397e0926eeb59be3add0112df5d003682"
},
"downloads": -1,
"filename": "mkdocs-dracula-theme-1.0.7.tar.gz",
"has_sig": false,
"md5_digest": "d9009b93683bf60b91916523428c7836",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 460112,
"upload_time": "2024-01-17T03:06:39",
"upload_time_iso_8601": "2024-01-17T03:06:39.435468Z",
"url": "https://files.pythonhosted.org/packages/5b/8d/f78f53f0cd6c6d2d349453f0b7a002e09d72360612887df7ea4045b012cf/mkdocs-dracula-theme-1.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-17 03:06:39",
"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"
}
JSON
