Metadata-Version: 2.1
Name: mkdocs-darkcinder
Version: 0.0.2
Summary: A clean, responsive MkDocs theme - Forked from Cinder with ❤
Home-page: https://github.com/ziroau/darkcinder
Author: ziroAU
License: MIT
Description-Content-Type: text/markdown
License-File: LICENSE.md

# DarkCinder

<div align="center", allowed_elements>

<a href="<http://ziroau.github.io/darkcinder>"> <img src="img/header.png" alt="DarkCinder | A clean, responsive theme for MkDocs" width="728"> </a>

[![PyPI - License](https://img.shields.io/pypi/l/mkdocs-darkcinder)](https://pypi.org/project/mkdocs-darkcinder/)
[![CI Build](https://github.com/ziroau/DarkCinder/actions/workflows/ci-build.yml/badge.svg)](https://github.com/ziroau/DarkCinder/actions/workflows/ci-build.yml)
[![CodeQL](https://github.com/ziroau/DarkCinder/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/ziroau/DarkCinder/actions/workflows/github-code-scanning/codeql)
[![PyPi Build](https://github.com/ziroau/DarkCinder/actions/workflows/pypi-package-upload.yml/badge.svg)](https://github.com/ziroau/DarkCinder/actions/workflows/pypi-package-upload.yml)
[![CodeFactor](https://www.codefactor.io/repository/github/ziroau/darkcinder/badge)](https://www.codefactor.io/repository/github/ziroau/darkcinder)
[![PyPI version](https://badge.fury.io/py/mkdocs-darkcinder.svg)](https://badge.fury.io/py/mkdocs-darkcinder)

[Demo](https://ziroau.github.io/darkcinder/)

A clean, responsive MkDocs static documentation site generator theme.

Forked from [Cinder](https://github.com/chrissimpkins/cinder) with ❤

[Cinder Demo and Documentation](http://sourcefoundry.org/cinder/)

<div align="left", allowed_elements>

## Installation

From [PyPI] (recommended):

```bash
pip install mkdocs-darkcinder
```

Or, from Git:

```bash
git clone https://github.com/ziroau/darkcinder.git
```

---

Preview:

</div>

![Preview Image](img/preview.png)

</div>

[PyPI]: https://pypi.org/mkdocs-darkcinder
