Skip to main content

Carbon theme for MkDocs

Project description

mkdocs-carbon

PyPI - Version PyPI - Python Version PyPI - Downloads

Carbon Design System theme for mkdocs.

Very much in beta state right now, contributions welcomed.

  • v1.2 Support for Header Navigation Menu
  • v1.1 Support for Search
  • v1.0 Initial Release

Examples

Installation

python -m pip install mkdocs-carbon

Usage

theme:
  name: carbon
  prefix: Durera
  theme_header: g100
  theme_sidenav: g90
  header_nav_items:
    - title: View on Github
      url: https://github.com/durera/mkdocs-carbon
      active: true
    - title: View on PyPi
      url: https://pypi.org/project/mkdocs-carbon/
      target: _new

markdown_extensions:
  - toc:
      permalink: "¤"

Theme Configuration

Prefix

The default prefix is Carbon, this is what appears before the Site Title in the header

Carbon Theme Selection

Easily switch between Carbon themes using theme_sidenav and theme_header, they can be set to white, g10, g90, or g100, by default the header uses g100, and the side navigation g10.

alt text alt text

Header Navigation Menu

The header navigation menu can be enabled by defining header_nav_items as a list of objects with url and title. Optionally control where the links open using target, or set a navigation item as active by adding active set to true.

alt text

Optional Page Metadata

Additional Breadcrumb Entries

The following metdata are supported, when set they will extend the breadcrumbs built from the nav structure by adding up to two extra entries before the final entry in the breadcrumb:

  • extra_breadcrumb_title_1
  • extra_breadcrumb_url_1
  • extra_breadcrumb_title_2
  • extra_breadcrumb_url_2

It's possible to only set the title for one or both of the entries if you don't want the breadcrumb element to take the user anywhere.

Associate Orphaned Page with Nav

An orphaned page can be connected to the navigation structure by setting the nav_title metadata to the title of the navigation item it should be connected to.

Fonts

Fonts are packaged in the theme itself:

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

mkdocs_carbon-1.2.3.tar.gz (161.7 kB view details)

Uploaded Source

Built Distribution

mkdocs_carbon-1.2.3-py2.py3-none-any.whl (164.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file mkdocs_carbon-1.2.3.tar.gz.

File metadata

  • Download URL: mkdocs_carbon-1.2.3.tar.gz
  • Upload date:
  • Size: 161.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.6

File hashes

Hashes for mkdocs_carbon-1.2.3.tar.gz
Algorithm Hash digest
SHA256 2b28a08550d6275fce219fc4ed51ccfa078bab486d59dea34a8a77978b2766e2
MD5 5bb2f9d46840839c20b5fcc755bb9940
BLAKE2b-256 afc40272b02ecdb60d283bcab83cda02623b7cafccf21ad840a7ccf013f9f09d

See more details on using hashes here.

File details

Details for the file mkdocs_carbon-1.2.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_carbon-1.2.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5853bc06ab51a35a372bf8d092619942f142f6bcdea6ac51dccb7c5b09247a23
MD5 4ee460e5797d8f3327e2b6a95ae2389d
BLAKE2b-256 673fff45879581efde28f2896a525185ed00db82a5daf547597e9a01a9fcd1c0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page