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
1 maintainer
Release files for mkdocs-semantic 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs-semantic-1.0.0.tar.gz | 1.1 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_semantic-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 2.2 MB
Release files / mkdocs-semantic-1.0.0.tar.gz
| Download URL | mkdocs-semantic-1.0.0.tar.gz |
|---|---|
| Size | 1.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c2aabd19c92ffa5157116ae702318650694022966117312b7cc722e4cd3d488a
|
|
BLAKE2b-256 checksum How to use checksums |
748d881c20bb9d267fad59dc0db06b9db94888aa24ebcb9c344578dd5ca3ff86
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2
|
Release files / mkdocs_semantic-1.0.0-py3-none-any.whl
| Download URL | mkdocs_semantic-1.0.0-py3-none-any.whl |
|---|---|
| Size | 1.1 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
410709519bc7648e6101940567045d21dc0f9995b4603e3a873bd189a0804eaa
|
|
BLAKE2b-256 checksum How to use checksums |
122eeff0c4f2f4c1e73fb522ed092523d36f5ded7dd6040ab3d7c16e5fec92a7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2
|
