Skip to content

Commit 95c893c

Browse files
committed
add a concrete example for per-page description overriding
1 parent 1c23924 commit 95c893c

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

docs/configuration.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,13 +173,32 @@ Default: `true`.
173173
Used, in combination with `abstract_delimiter`, to determine each [item description element](https://www.w3schools.com/xml/rss_tag_title_link_description_item.asp):
174174

175175
- If this value is set to `-1`, then the articles' full HTML content will be filled into the description element.
176-
- If the `rss.feed_description` per-page is set, that will override the site description and the plugin description.
176+
- If you want to customize the description per each Markdown page, refer to the example below.
177177
- Otherwise, the plugin first tries to retrieve the value of the keyword `description` from the [page metadata].
178178
- If that fails and `abstract_delimiter` is found in the page, the article content up to (but not including) the delimiter is used.
179179
- If the above has failed, then the plugin retrieves the first number of characters of the page content defined by this setting. Retrieved content is the raw markdown converted roughly into HTML.
180180

181181
Be careful: if set to `0` and there is no description, the feed's compliance is broken (an item must have a description).
182182

183+
#### Override feed description per page
184+
185+
To customize the value of the RSS description per each page and override the value of `site_description` and `plugins.rss.feed_description`, you can modify the value per each page as you see in the example below:
186+
187+
```markdown
188+
---
189+
date: 2024-06-24
190+
description: >-
191+
This is the SEO description.
192+
social:
193+
cards_layout_options:
194+
description: >-
195+
This is the social cards description.
196+
rss:
197+
feed_description: >-
198+
And I want to have customized RSS description.
199+
---
200+
```
201+
183202
`abstract_chars_count`: number of characters to use as item description.
184203

185204
Default: `150`

0 commit comments

Comments
 (0)