Skip to main content

MkDocs plugin for TCCP documentation styles

Project description

TCCP Docs Styles MkDocs Plugin

This plugin adds custom styles to a MkDocs project that uses MkDocs Material.

  • Modus light and dark theme
  • Adds favicon and logo
  • Modus themed admonitions
  • Call to action buttons
  • Modus color variables

Check out the official Modus Style Guide

Installation

pip install mkdocs-tccp-docs-styles

Usage

Add to your mkdocs.yml file

plugins:
  - tccp-docs-styles
      

Dependencies

This plugin expects the following markdown extensions to be installed

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences  
  - attr_list

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_tccp_docs_styles-0.2.10.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_tccp_docs_styles-0.2.10-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_tccp_docs_styles-0.2.10.tar.gz.

File metadata

  • Download URL: mkdocs_tccp_docs_styles-0.2.10.tar.gz
  • Upload date:
  • Size: 10.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.11

File hashes

Hashes for mkdocs_tccp_docs_styles-0.2.10.tar.gz
Algorithm Hash digest
SHA256 c54083a30861e6170fbd304ea4a121b02d29e5279d1c39868ca5286887bc1c6f
MD5 78ffa62a48eca77e16bcbba9a75b1aa5
BLAKE2b-256 873ca6c1e946510494db079e4f0d71c1848b671e4e7aca6f2bd527afd93aaae7

See more details on using hashes here.

File details

Details for the file mkdocs_tccp_docs_styles-0.2.10-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_tccp_docs_styles-0.2.10-py3-none-any.whl
Algorithm Hash digest
SHA256 f06f0044ac17c7c93cec23f507739b2838ffe2eacbf5ab4a885f448129d1163e
MD5 e5504ea298a9287842ffb456dd21cd4d
BLAKE2b-256 abcf91f4e9aed772403f18ec0ba3cd9960268b06ccb01390c0350e0ac6f9a567

See more details on using hashes here.

Supported by

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