Ignore with .mkdocsignore

mkdocs.yml

# Ignore files with a .mkdocsignore file.
site_name: ok-mkdocsignore
plugins:
  - simple

Input

ok-mkdocsignore/
├── .mkdocsignore
├── hello/
│   ├── foo/
│   │   ├── bar.md
│   │   └── foo.md
│   ├── hello.md
│   └── world/
│       ├── .mkdocsignore
│       └── world.md
├── mkdocs.yml
├── README.md
└── test/
    ├── bar.md
    └── foo.md

.mkdocsignore

# Ignore everything in the test folder
test
# Ignore the foo file in hello/foo
hello/foo/foo*

hello/world/.mkdocsignore

# Ignore everything in this folder

Output

site/
├── hello/
│   ├── foo/
│   │   └── bar/
│   │       └── index.html
│   └── hello/
│       └── index.html
└── index.html

---

Last update: August 25, 2023