https://github.com/mattchristopher314/mkdocs-title-casing-plugin

A lightweight mkdocs plugin to add title casing to all mkdocs pages and sections.
https://github.com/mattchristopher314/mkdocs-title-casing-plugin

mkdocs mkdocs-plugin

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/mattchristopher314/mkdocs-title-casing-plugin
• Owner: mattchristopher314
• License: gpl-3.0
• Created: 2021-09-04T16:33:06.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-09-02T18:02:57.000Z (over 1 year ago)
• Last Synced: 2024-11-16T17:44:47.628Z (about 1 month ago)
• Topics: mkdocs, mkdocs-plugin
• Language: Python
• Homepage: https://pypi.org/project/mkdocs-title-casing-plugin/
• Size: 37.1 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![PyPI](https://img.shields.io/pypi/v/mkdocs-title-casing-plugin)

![PyPI - License](https://img.shields.io/pypi/l/mkdocs-title-casing-plugin)

# mkdocs-title-casing-plugin

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

Uses [python-titlecase](https://github.com/ppannuto/python-titlecase) for formatting.

## Setup

Install the plugin using pip:

```bash

pip install mkdocs-title-casing-plugin

```

Include the plugin in `mkdocs.yml`. For example:

```yml

plugins:

  - search

  - title-casing

```

> 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`.

### Configuration

* `capitalization_type` (string)

  * `title` - default - gives `War and Peace`.

  * `first_letter` - gives `War And Peace`.

* `default_page_name` (string). The page name to use when it cannot be determined automatically. Default is `Home`.

#### Example mkdocs.yml

```yml

plugins:

  - search

  - title-casing:

      capitalization_type: first_letter

      default_page_name: Index

```