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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

Details for the file mkdocs_tablestrip-1.0.4.tar.gz.

File metadata

  • Download URL: mkdocs_tablestrip-1.0.4.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for mkdocs_tablestrip-1.0.4.tar.gz
Algorithm Hash digest
SHA256 fd62a66b8240df65dc375c876868a20c681a40abae2791a32aeb3d074cfba064
MD5 3cf886b32d581443da9e59f64860898c
BLAKE2b-256 ed6da2dfbb6dca5802445bfe916d231afe4fc97a9b00435a9b38470f992e302c

See more details on using hashes here.

File details

Details for the file mkdocs_tablestrip-1.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_tablestrip-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 a6541bc3bd043cf3aeaf83167454bb727cd6a1601be3a53205eec7ebca3de91b
MD5 3333bb19bfddedf545a23b6795707cb8
BLAKE2b-256 62032b78000968e3368e40c2c0ee426267c7f3966fc9d5aa406a3eaa2b715112

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page