{"id":15057022,"url":"https://github.com/chrieke/mkdocs-exclude-search","last_synced_at":"2025-04-10T10:05:45.606Z","repository":{"id":38196025,"uuid":"303229172","full_name":"chrieke/mkdocs-exclude-search","owner":"chrieke","description":"🔎 A mkdocs plugin that excludes selected chapters from the docs search index.","archived":false,"fork":false,"pushed_at":"2023-12-04T02:34:50.000Z","size":104,"stargazers_count":27,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-16T10:51:53.242Z","etag":null,"topics":["documentation","mkdocs","mkdocs-material","mkdocs-plugin","plugin","search"],"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/chrieke.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2020-10-11T23:10:29.000Z","updated_at":"2024-09-20T00:34:40.000Z","dependencies_parsed_at":"2023-11-20T19:29:29.593Z","dependency_job_id":"9a87d256-a3c6-473f-a13a-b771ee4ddbdc","html_url":"https://github.com/chrieke/mkdocs-exclude-search","commit_stats":{"total_commits":127,"total_committers":6,"mean_commits":"21.166666666666668","dds":0.1889763779527559,"last_synced_commit":"a9b182e4acc9e7d335978e5fbaf64629169d219c"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrieke%2Fmkdocs-exclude-search","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrieke%2Fmkdocs-exclude-search/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrieke%2Fmkdocs-exclude-search/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrieke%2Fmkdocs-exclude-search/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chrieke","download_url":"https://codeload.github.com/chrieke/mkdocs-exclude-search/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239212562,"owners_count":19600830,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["documentation","mkdocs","mkdocs-material","mkdocs-plugin","plugin","search"],"created_at":"2024-09-24T22:00:59.767Z","updated_at":"2025-02-16T23:32:36.414Z","avatar_url":"https://github.com/chrieke.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mkdocs-exclude-search\n\nA mkdocs plugin that excludes selected chapters from the docs search index.\n\nIf you only need to exclude a few pages or sections, mkdocs-material now introduced \n[built-in search exclusion](https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-exclusion)! \nThe **mkdocs-exclude-search** plugin \n[complements](https://squidfunk.github.io/mkdocs-material/blog/2021/09/26/excluding-content-from-search/#whats-new) \nthis with more configuration options (wildcard exclusions, ignoring excluded subsections). It also provides \nsearch-exclusion functionality to regular mkdocs users.\n\n\u003cp align=\"center\"\u003e\n    \u003cimg alt=\"PyPI - Downloads\" src=\"https://img.shields.io/pypi/dm/mkdocs-exclude-search\"\u003e\n    \u003ca href=\"https://pypi.org/project/mkdocs-exclude-search/\" title=\"mkdocs-exclude-search on pypi\"\u003e\u003cimg src=\"https://img.shields.io/pypi/v/mkdocs-exclude-search?color=brightgreen\"\u003e\u003c/a\u003e\n    \u003cimg src=\"./coverage.svg\"\u003e\n\u003c/p\u003e\n\n## Setup\n\nInstall the plugin using pip:\n\n```bash\npip install mkdocs-exclude-search\n```\n\n**Activate the `search` and `exclude-search` plugins in `mkdocs.yml`**. `search` is required, otherwise \n`exclude-search` has no effect!\n\n```yaml\nplugins:\n  - search\n  - exclude-search\n```\n\nMore information about plugins in the [MkDocs documentation][mkdocs-plugins].\n\n## Configuration\n\n- List the markdown files to be excluded under `exclude` using the format `\u003cpath\u003e/\u003cto\u003e/filename.md` in the docs folder.\n- Exclude specific heading subsections using the format `\u003cpath\u003e/\u003cto\u003e/filename.md#some-heading`. Chapter names are all lowercase, `-` as separator, no spaces.\n- Exclude all markdown files within a directory (and its children) with `dirname/*`.\n- Exclude all markdown files with a specific name within all subdirectories with `dirname/*/filename.md` or `/*/filename.md`.    \n- To still include a subsection of an excluded file, list the subsection heading under `ignore` using the format `\u003cpath\u003e/\u003cto\u003e/filename.md#some-heading`. \n- To exclude all unreferenced files (markdown files not listed in mkdocs.yml nav section), use `exclude_unreferenced: true`. Default false.\n\n```yaml\nplugins:\n  - search\n  - exclude-search:\n      exclude:\n        - first.md\n        - dir/second.md\n        - third.md#some-heading\n        - dir2/*\n        - /*/fifth.md\n      ignore:\n        - dir/second.md#some-heading\n      exclude_unreferenced: true\n\n```\n```yaml\nnav:\n    - Home: index.md\n    - First chapter: first.md\n    - Second chapter: dir/second.md\n    - Third chapter: third.md\n    - Fourth chapter: dir2/fourth.md\n    - Fifth chapter: subdir/fifth.md\n```\n\nThis example would exclude:\n- the first chapter.\n- the second chapter (but still include its `some-heading` section).\n- the `some-heading` section of the third chapter.\n- all markdown files within `dir2` (and its children directories).\n- all markdown files named `fifth.md` within all subdirectories.\n- all unreferenced files\n\n## See Also\n\nMore information about templates [here][mkdocs-template].\n\nMore information about blocks [here][mkdocs-block].\n\n[mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/\n[mkdocs-template]: https://www.mkdocs.org/user-guide/custom-themes/#template-variables\n[mkdocs-block]: https://www.mkdocs.org/user-guide/styling-your-docs/#overriding-template-blocks\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrieke%2Fmkdocs-exclude-search","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchrieke%2Fmkdocs-exclude-search","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrieke%2Fmkdocs-exclude-search/lists"}