behroozam / mkdocs-jinks-theme

:smile_cat: Mkdocs jinks theme

MkDocs Jinks(modify to rangi) Themes

screenshots

Mkdocs-jinks is a set of Mkdocs additional themes, which also supported RTL direction in Persian version.

• Persian Demo

Dependency

Mkdocs-jinks uses Mkdocs project to create themes as well as other official MKDocs themes, which has been written in Python.

Before installing MKDocs-jinks you need to install the following dependencies:

• Python
• pip
• Mkdocs

Installation

You can easily download orginal yellow** Jinks themes with Pip:

pip install mkdocs-jinks

for modify theme just :

git clone https://github.com/behroozam/mkdocs-jinks-theme

cd mkdocs-jinks-theme

sudo python setup.py install

or for development ( egg issu)

sudo python setup.py develop

And run it like other mkdocs themes by following below command:

mkdocs serve

For more information about using Persian and English version of jinks theme you can refer to Persian and English Jinks documentation.