dracula/mkdocs

🧛🏻‍♂️ Dark theme for Mkdocs

Dracula for Mkdocs

A dark theme for Mkdocs.

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.

Team

This theme is maintained by the following person(s) and a bunch of awesome contributors.

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.

• 🐛 Bug Report
• 📕 Documentation Issue
• 🚀 Feature Request
• 💬 General Question

Commit Style

• ⚙️ FEATURE
• 📝 PEP8
• 📌 ISSUE
• 🪲 BUG
• 📘 DOCS
• 📦 PyPI
• ❤️️ TEST
• ⬆️ CI/CD
• ⚠️ SECURITY

License

MIT License

mkdocs's Issues

(short issue description)

Describe the feature

test

Use Case

test

Proposed Solution

test

Other Information

test

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

SDK version used

1

Environment details (OS name and version, etc.)

test

Fix: hidden navbar toggler button

• #16 (comment)

Update MkDocs version to 1.4.3

(short issue description)

Describe the bug

test

Expected Behavior

test

Current Behavior

test

Reproduction Steps

test

Possible Solution

test

Additional Information/Context

test

SDK version used

1

Environment details (OS name and version, etc.)

test

(short issue description)

Describe the bug

test

Expected Behavior

test

Current Behavior

test

Reproduction Steps

test

Possible Solution

test

Additional Information/Context

test

SDK version used

1

Environment details (OS name and version, etc.)

archlinux

(short issue description)

Describe the issue

test

Links

test

FEATURE: Implement option to search contents

Description:

• Create a new feature to search for information, enabling the user to find the content faster.

Screenshot

Location Modification

(short issue description)

Describe the feature

test

Use Case

test

Proposed Solution

test

Other Information

test

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

SDK version used

1

Environment details (OS name and version, etc.)

archlinux

FEATURE: Create 404 page

Description:

Screenshot

Example:

Standardization of rep

Hi @FernandoCelmer, we need to adjust a few things first to move forward, ok? ✨

We need a separate .md with installation instructions to show the theme on the site.

I ask for these changes to standardize with the other repositories see an example; this is also important because it helps other potential users who would like to contribute too! 😁

Let me know if something isn't possible or if you have any questions! 🙂

FEATURE: Create dropdown menu in sidebar

Description:

• Create dropdown menu in sidebar.

Screenshot

Location Modification:

Example:

(short issue description)

Describe the issue

test

Links

test

No syntax highlighting in code blocks