Skip to main content

A lightweight mkdocs plugin to add title casing to all mkdocs pages and sections

Project description

PyPI PyPI - License

mkdocs-title-casing-plugin

A lightweight mkdocs plugin to add title casing to all mkdocs pages and sections. Uses python-titlecase for formatting.

Setup

Install the plugin using pip:

pip install mkdocs-title-casing-plugin

Include the plugin in mkdocs.yml. For example:

plugins:
  - search
  - git-authors

If this is the first plugins entry that you are adding, you should probably also add search as this is enabled by default.

Usage

When the plugin is enabled, all section and page titles will be converted to use Title Case. For example, War and peace becomes War and Peace.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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