{"id":20143867,"url":"https://github.com/six-two/mkdocs-remove-sections-plugin","last_synced_at":"2026-02-26T06:29:00.510Z","repository":{"id":260916829,"uuid":"882684851","full_name":"six-two/mkdocs-remove-sections-plugin","owner":"six-two","description":"Remove sections with specific titles from your MkDocs pages","archived":false,"fork":false,"pushed_at":"2024-11-12T17:45:58.000Z","size":15,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-19T00:47:12.823Z","etag":null,"topics":["mkdocs","mkdocs-plugin","redaction"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/six-two.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-03T13:46:10.000Z","updated_at":"2026-02-04T20:03:17.000Z","dependencies_parsed_at":"2025-04-09T18:53:37.655Z","dependency_job_id":"d731babe-3e10-4e8c-87b9-4dd677d01709","html_url":"https://github.com/six-two/mkdocs-remove-sections-plugin","commit_stats":null,"previous_names":["six-two/mkdocs-remove-sections-plugin"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/six-two/mkdocs-remove-sections-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/six-two%2Fmkdocs-remove-sections-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/six-two%2Fmkdocs-remove-sections-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/six-two%2Fmkdocs-remove-sections-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/six-two%2Fmkdocs-remove-sections-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/six-two","download_url":"https://codeload.github.com/six-two/mkdocs-remove-sections-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/six-two%2Fmkdocs-remove-sections-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29850098,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-25T22:37:40.667Z","status":"online","status_checked_at":"2026-02-26T02:00:06.774Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mkdocs","mkdocs-plugin","redaction"],"created_at":"2024-11-13T22:05:46.525Z","updated_at":"2026-02-26T06:29:00.471Z","avatar_url":"https://github.com/six-two.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MkDocs Remove Sections Plugin\n\n[![PyPI version](https://img.shields.io/pypi/v/mkdocs-remove-sections-plugin)](https://pypi.org/project/mkdocs-remove-sections-plugin/)\n![License](https://img.shields.io/pypi/l/mkdocs-remove-sections-plugin)\n![Python versions](https://img.shields.io/pypi/pyversions/mkdocs-remove-sections-plugin)\n\nRemove marked sections from pages.\nFor example to remove private information from a public version of a web site.\n\n## Installation\n\nYou can install it with `pip`:\n```bash\npip install mkdocs-remove-sections-plugin\n```\n\n## Usage\n\nAdd the plugin to your `mkdocs.yml`:\n```yaml\nplugins:\n- search\n- remove_sections\n```\n\nTo remove a section and its subsections, you can begin its title with `Private:` like `## Private: My section`.\n\nIf you need a more precise removal, you can also manually set start and end points for the removal.\nAny content on pages between `\u003c!-- remove:start --\u003e` and `\u003c!-- remove:end --\u003e` is replaced by the plugin with the text `Some content has been redacted in this version`.\nIf there are uncertanities (start and end tags do not propperly match up), then this plugin will default to cutting too much rather than too little.\nIn addition a warning is shown during the build.\n\n## Configuration\n\nYou can configure the plugin with the following options.\nThe information shown below shows the default values:\n```yaml\nplugins:\n- search\n- remove_sections:\n    section_start_pattern: \"\u003c!--\\\\s*remove:start\\\\s*--\u003e\"\n    section_end_pattern: \"\u003c!--\\\\s*remove:end\\\\s*--\u003e\"\n    section_heading_pattern: \"^Private: \"\n    section_replace_with: \"\\n\\n\u003e Some content has been redacted in this version.\\n\\n\"\n    regex_case_sensitive: false\n```\n\n### section_start_pattern\n\nRegular expression pattern that marks the start of a section that should be removed.\n\n### section_end_pattern\n\nRegular expression pattern that marks the end of a section that should be removed.\n\n### section_heading_pattern\n\nRegular expression for a section heading (`h1` through `h6`) that marks a section to be removed.\nAny subsections are removed as well.\nYou can use it like this:\n```markdown\n## Private: Section to remove\n```\n\n### section_replace_with\n\nThe removed content will be replaced with this text.\nYou can set an empty string to remove it entirely.\nBy default a placeholder is shown, so that you see that something was removed.\n\n### regex_case_sensitive\n\nThis controls, whether the patterns you defined with the other options should be case sensitive or insensitive.\nIt defaults to case insensitive.\n\n## Notable changes\n\n### Version 0.1.0\n\n- Added removing sections by title\n\n### Version 0.0.1\n\n- Initial version\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsix-two%2Fmkdocs-remove-sections-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsix-two%2Fmkdocs-remove-sections-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsix-two%2Fmkdocs-remove-sections-plugin/lists"}