Skip to content

Ignore a folder

mkdocs.yml

# This example shows how a subfolder can be ignored.
site_name: ok-mkdocs-docs-ignore
plugins:
  - simple:
      ignore_folders: ["subfolder"]

Input

ok-mkdocs-docs-ignore/
├── mkdocs.yml
├── other-folder/
│   └── subfolder/
│       ├── draft.md
│       └── index.md
├── README.md
├── subfolder/
│   ├── draft.md
│   └── index.md
└── test.md

Output

site/
├── assets/
│   ├── images/
│   │   └── favicon.png
│   ├── javascripts/
│   │   ├── lunr/
│   │   │   └── min/
│   │   └── workers/
│   └── stylesheets/
├── index.html
├── other-folder/
│   └── subfolder/
│       ├── draft/
│       │   └── index.html
│       └── index.html
└── test/
    └── index.html