Metadata-Version: 2.1
Name: mkdocs-semantic
Version: 0.0.5
Summary: Semantic-UI Theme for MkDocs
Home-page: https://github.com/cryocaustik/mkdocs-semantic
Author: https://github.com/cryocaustik
Author-email: cryocaustik@gmail.com
License: MIT
Platform: UNKNOWN
Description-Content-Type: text/markdown

# mkdocs-semantic

Minimalistic [Semantic-UI](https://semantic-ui.com/) theme for [MkDocs](https://www.mkdocs.org/) with a focus on web content.


## Example

[![mkdocs-semantic](img/mkdocs-semantic.png)](img/mkdocs-semantic.png)

<br/>

## Installation & Usage

```python
# using local terminal
pip install mkdocs-semantic
```

```yml
# in your mkdocs.yml file
theme: semantic
```
<br/>

## Custom Config Variables

- `logo_url`: if specified, will be used in the navbar before the site name

<br/>

## Dependencies

- [Semantic-UI >= 2.4](https://semantic-ui.com/)
- [highlight.js >= 9.12.0](https://highlightjs.org/)
- [jQuery >= 3.3.1](https://jquery.com/)

<br/>

## Project Road Map

- [ ] setup demo site 
- [ ] develop doc-focused variant of theme

