Skip to main content

This mkdocs plugin allows you to strip rows from tables across your documentation.

Project description

Mkdocs Tablestrip Plugin

This plugin allows you to strip rows from tables across your documentation. It searches for a specific heading-keyword and then removes the corresponding row from the HTML output. The Markdown files remain unchanged.

This can be useful if your documentation contains data that is automatically parsed but not relevant for the end user.

Installation

pip install mkdocs-tablestrip

Consider adding the plugins to a requirements.txt file alongside other Python dependencies for your project.

Setup

Add the plugin to your mkdocs.yml file:

plugins:
  - tablestrip

Configuration

There is only a single configuration option for this plugin: The keyword used to identify the row that should be removed.

plugins:
  - tablestrip:
      strip_word: "Expert"

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_tablestrip-1.0.4.tar.gz (3.3 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_tablestrip-1.0.4-py3-none-any.whl (3.7 kB view hashes)

Uploaded Python 3

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