mkdocs-tablestrip

Name	mkdocs-tablestrip JSON
Version	1.0.4 JSON
	download
home_page	None
Summary	This mkdocs plugin allows you to strip rows from tables across your documentation.
upload_time	2024-08-17 18:25:01
maintainer	None
docs_url	None
author	None
requires_python	>=3.7
license	None
keywords	mkdocs table strip data documentation
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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:

```yaml
plugins:
  - tablestrip
```
## Configuration

There is only a single configuration option for this plugin: The keyword used to identify the row that should be removed.
```yaml
plugins:
  - tablestrip:
      strip_word: "Expert"
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mkdocs-tablestrip",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "mkdocs, table, strip, data, documentation",
    "author": null,
    "author_email": "CyberOtter <baum.np79a@slmail.me>",
    "download_url": "https://files.pythonhosted.org/packages/ed/6d/a2dfbb6dca5802445bfe916d231afe4fc97a9b00435a9b38470f992e302c/mkdocs_tablestrip-1.0.4.tar.gz",
    "platform": null,
    "description": "# Mkdocs Tablestrip Plugin\n\nThis plugin allows you to strip rows from tables across your documentation.\nIt searches for a specific heading-keyword and then removes the corresponding row from the HTML output.\nThe Markdown files remain unchanged.\n\nThis can be useful if your documentation contains data that is automatically parsed but not relevant for the end user.\n \n## Installation\n`pip install mkdocs-tablestrip`\n\nConsider adding the plugins to a `requirements.txt` file alongside other Python dependencies for your project.\n\n## Setup\nAdd the plugin to your `mkdocs.yml` file:\n\n```yaml\nplugins:\n  - tablestrip\n```\n## Configuration\n\nThere is only a single configuration option for this plugin: The keyword used to identify the row that should be removed.\n```yaml\nplugins:\n  - tablestrip:\n      strip_word: \"Expert\"\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "This mkdocs plugin allows you to strip rows from tables across your documentation.",
    "version": "1.0.4",
    "project_urls": {
        "Bug Tracker": "https://github.com/SaltyAimbOtter/mkdocs-tablestrip/issues",
        "Homepage": "https://github.com/SaltyAimbOtter/mkdocs-tablestrip"
    },
    "split_keywords": [
        "mkdocs",
        " table",
        " strip",
        " data",
        " documentation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "62032b78000968e3368e40c2c0ee426267c7f3966fc9d5aa406a3eaa2b715112",
                "md5": "3333bb19bfddedf545a23b6795707cb8",
                "sha256": "a6541bc3bd043cf3aeaf83167454bb727cd6a1601be3a53205eec7ebca3de91b"
            },
            "downloads": -1,
            "filename": "mkdocs_tablestrip-1.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3333bb19bfddedf545a23b6795707cb8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 3706,
            "upload_time": "2024-08-17T18:25:00",
            "upload_time_iso_8601": "2024-08-17T18:25:00.441161Z",
            "url": "https://files.pythonhosted.org/packages/62/03/2b78000968e3368e40c2c0ee426267c7f3966fc9d5aa406a3eaa2b715112/mkdocs_tablestrip-1.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ed6da2dfbb6dca5802445bfe916d231afe4fc97a9b00435a9b38470f992e302c",
                "md5": "3cf886b32d581443da9e59f64860898c",
                "sha256": "fd62a66b8240df65dc375c876868a20c681a40abae2791a32aeb3d074cfba064"
            },
            "downloads": -1,
            "filename": "mkdocs_tablestrip-1.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "3cf886b32d581443da9e59f64860898c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 3289,
            "upload_time": "2024-08-17T18:25:01",
            "upload_time_iso_8601": "2024-08-17T18:25:01.822481Z",
            "url": "https://files.pythonhosted.org/packages/ed/6d/a2dfbb6dca5802445bfe916d231afe4fc97a9b00435a9b38470f992e302c/mkdocs_tablestrip-1.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-17 18:25:01",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "SaltyAimbOtter",
    "github_project": "mkdocs-tablestrip",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "mkdocs-tablestrip"
}