Metadata-Version: 2.3
Name: mkdocs-dracula-theme
Version: 1.0.8
Summary: Dark theme for Mkdocs
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
Author: Fernando Celmer
Author-email: email@fernandocelmer.com
Maintainer: Fernando Celmer
Maintainer-email: email@fernandocelmer.com
Requires-Python: >=3.9
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: mkdocs (>=1.6.1,<2.0.0)
Project-URL: Changelog, https://dracula.github.io/mkdocs/nav/development/release-notes
Project-URL: Documentation, https://dracula.github.io/mkdocs
Project-URL: Homepage, https://draculatheme.com/mkdocs
Project-URL: Issues, https://github.com/dracula/mkdocs/issues
Project-URL: Repository, https://github.com/dracula/mkdocs
Description-Content-Type: text/markdown

# Dracula for [Mkdocs](https://www.mkdocs.org/)

> A dark theme for [Mkdocs](https://www.mkdocs.org/).

![Screenshot](https://raw.githubusercontent.com/dracula/mkdocs/main/screenshot.png)

## 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).

| [![Fernando Celmer](https://github.com/FernandoCelmer.png?size=100)](https://github.com/FernandoCelmer) | [![Lautaro Linquimán](https://github.com/Ymil.png?size=100)](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)

