https://github.com/dracula/mkdocs

🧛🏻‍♂️ Dark theme for Mkdocs
https://github.com/dracula/mkdocs

documentation documentation-tool dracula-theme material-ui mkdocs mkdocs-site mkdocs-theme python python-3 python3 theme theme-ui themes

Last synced: 3 days ago
JSON representation

🧛🏻‍♂️ Dark theme for Mkdocs

• Host: GitHub
• URL: https://github.com/dracula/mkdocs
• Owner: dracula
• License: mit
• Created: 2023-03-22T14:29:51.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-17T05:08:44.000Z (9 months ago)
• Last Synced: 2024-09-25T20:39:02.140Z (8 days ago)
• Topics: documentation, documentation-tool, dracula-theme, material-ui, mkdocs, mkdocs-site, mkdocs-theme, python, python-3, python3, theme, theme-ui, themes
• Language: HTML
• Homepage: https://dracula.github.io/mkdocs/
• Size: 3.1 MB
• Stars: 72
• Watchers: 3
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

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

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

- 💬 [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)