mkdocs-strings-replacement

mkdocs-strings-replacement

Mkdocs Markdown strings replacement plugin.

Installation

pip install mkdocs-strings-replacement

Documentation

Setup

Enable the plugin in your mkdocs.yml:

plugins:
  - mkdocs-strings-replacement:
      strings_replacements:
        - old_value: "This string will be replaced"
          new_value: "with this string"

Note:

• You can replace how many strings as you want. strings_replacements is an array of pairs of the old_value's of the strings you want to replace with new_value's of the strings you want to put there in exchange.
• If you add more then one old_value and new_value pairs then the replacement will occur from the top to the bottom of the pairs you have passed.
• Replacement will happen for any strings in the markdown, that is also for the content of your markdown file as well as in the titles.
• Replacement will happen before rendering your pages.

Example

plugins:
  - mkdocs-strings-replacement:
      strings_replacements:
        - old_value: "[[_TOSP_]]"
          new_value: ""
        - old_value: "[[_TOC_]]"
          new_value: ""

In the given example:

• First your occurance of [[_TOSP_]] will be replaced with nothing, which will results in erasing [[_TOSP_]] from your pages.
• Then from the results [[_TOC_]] will be replaced with empty string as well.

Development setup

To install the dependencies for the plugin, run:

pip install .

To set up the development environment, including dependencies for running tests, run:

pip install -e .[dev]

To run the tests, use:

pytest