Skip to main content

Semantic-UI Theme for MkDocs

Project description

mkdocs-semantic

Minimalistic Semantic-UI theme for MkDocs with a focus on web content.

Example

mkdocs-semantic


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

Github


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.

Files for mkdocs-semantic, version 0.0.6
Filename, size File type Python version Upload date Hashes
Filename, size mkdocs_semantic-0.0.6-py3-none-any.whl (1.1 MB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size mkdocs-semantic-0.0.6.tar.gz (1.1 MB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page