Semantic-UI Theme for MkDocs
Project description
mkdocs-semantic
Minimalistic Semantic-UI theme for MkDocs with a focus on web content.
Example
Installation & Usage
# using local terminal
pip install mkdocs-semantic
# in your mkdocs.yml file
theme: semantic
Configuration
Theme customizations options
Logo
The default logo is the Python icon from Semantic-UI, however it can be overidden using an image or an icon.
To use an image, specify the URL or relative path to the image:
theme:
logo:
image: 'images/logo.png'
To use an icon, specify the name of a Semantic-UI icon:
theme:
logo:
icon: 'python'
Breadcrumbs
The breadcrumbs are enabled by default, but can be disabled through the breadcrumb variable:
theme:
breadcrumb: false
Sidebar
The sidebar is enabled by default, but can be disabled through the sidebar variable:
theme:
sidebar: false
Search
The search functionality is enabled by default (adding a search icon to the navbar), but can be disabled through the search variable:
theme:
search: false
Dependencies
Source
Project Road Map
- add toc
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mkdocs_semantic-0.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 56accfb3b452cc23e2eab3c7fd2012af3dc7f12388d2aebc7826be2f3a44be43 |
|
MD5 | 79551d4d61091fdbeadf13222d126352 |
|
BLAKE2b-256 | 3732c6632ad824c0d84bce5fd7ec76f81b1666c57568f5df24615d616c15aa9e |