Skip to content

Commit

Permalink
Merge pull request #28 from m0wer/patch-2
Browse files Browse the repository at this point in the history
docs(install): exclude newsletters from search
  • Loading branch information
lyz-code committed Apr 19, 2021
2 parents 4421d21 + 02abc06 commit c283420
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion docs/install.md
Expand Up @@ -217,4 +217,21 @@ It assumes that you have the next `Makefile`:

If you don't want to see the newsletters in the result of the search, use the
[mkdocs-exclude-search](https://pypi.org/project/mkdocs-exclude-search/) plugin
to exclude all articles under `docs/newsletter`.
to exclude all articles under `newsletter/`.

To do so:

1. Install the plugin with
```bash
pip install mkdocs-exclude-search
```
1. Add the following configuration to your `mkdocs.yml`
```yaml
plugins:
- search
- exclude-search:
exclude:
- newsletter/*
```

Note that `newsletter/*` excludes all markdown files within a directory and its children. The paths must be relative to the `docs/` directory.

0 comments on commit c283420

Please sign in to comment.