mkdocs-tccp-docs-styles 0.2.6

MkDocs plugin for TCCP documentation styles

TCCP Docs Styles MkDocs Plugin

This plugin adds custom styles to a MkDocs project that uses MkDocs Material. It uses the Modus colors from Trimble and automatically adds the pallet node to the theme to enable dark mode and the theme switcher.

Demo Site

Installation

pip install 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

Developing

Setup your environment, different steps for demo or deploy

All

# setup a virtual python env
python3 -m venv .venv

# source your python env
source .venv/bin/activate

# install dependencies
pip install -r requirements.txt

Demo - Local

# install the plugin in development mode
pip install -e .

# serve the develop/demo project
mkdocs serve

Demo - GH Pages (Action)

# install the plugin in development mode
pip install -e .

# serve the develop/demo project
mkdocs gh-deploy --force

Deploy

# build the plugin
python3 -m build

# push package to test pypi
twine upload -r testpypi dist/*

# push package to pypi
python3 -m twine upload dist/*

Solving some of the issues publishing the plugin

SSL Cert verification error

# For Python installed via pyenv or Homebrew
/Applications/Python\ 3.12/Install\ Certificates.command