Skip to content

Commit 96fec9f

Browse files
committed
docs(cache_dir): add section about new cache_dir option
1 parent c883ee8 commit 96fec9f

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/configuration.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,28 @@ Default: `<!-- more -->`
195195

196196
----
197197

198+
### :material-recycle: `cache_dir`: folder where to store plugin's cached files { #cache_dir }
199+
200+
The plugin implements a caching mechanism, ensuring that a remote media is only get once during its life-cycle on remote HTTP server (using [Cache Control](https://pypi.org/project/CacheControl/) under the hood). It is normally not necessary to specify this setting, except for when you want to change the path within your root directory where HTTP body and metadata files are cached.
201+
202+
If you want to change it, use:
203+
204+
``` yaml
205+
plugins:
206+
- rss:
207+
cache_dir: my/custom/dir
208+
```
209+
210+
It's strongly recommended to add the path to your `.gitignore` file in the root of your project:
211+
212+
``` title=".gitignore"
213+
.cache
214+
```
215+
216+
Default: `.cache/plugins/rss`.
217+
218+
----
219+
198220
### :material-tag-multiple: `categories`: item categories { #categories }
199221

200222
`categories`: list of page metadata values to use as [RSS item categories](https://www.w3schools.com/xml/rss_tag_category_item.asp).

0 commit comments

Comments
 (0)