Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Moyf committed Dec 12, 2024
1 parent c443fa8 commit b98d268
Showing 1 changed file with 9 additions and 15 deletions.
24 changes: 9 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,7 @@ You can also use the ``folder-index-content`` Block processor directly like this
```
````

to include the content of the folder index in any note you want

You can also exclude specific files or folders in the code block using the `ignore` option:

````
```folder-index-content
ignore: folder1/, *test*, *.pdf
```
````

The `ignore` option supports:
- Multiple patterns separated by commas
- Wildcards using `*` (e.g., `*.pdf` to exclude all PDF files)
- This works in addition to the global exclude patterns in the plugin settings
to include the content of the folder index in any note you want.

#### Frontmatter

Expand All @@ -67,11 +54,18 @@ The `folder-index-content` code block supports the following configuration optio
| recursionLimit | Override the global subfolder limit for this index | `recursionLimit: 2` |

Example:
````md
```folder-index-content
title: Project Files
ignore: *.pdf, *img*, temp
ignore: *.pdf, *img*, temp, Folder/
recursionLimit: 2
```
````

The `ignore` option supports:
- Multiple patterns separated by commas
- Wildcards using `*` (e.g., `*.pdf` to exclude all PDF files)
- This works in addition to the global exclude patterns in the plugin settings

### Settings

Expand Down

0 comments on commit b98d268

Please sign in to comment.