Skip to content

Commit 9d117cd

Browse files
committed
Add doc about abstract delimiter
1 parent ae9ae8f commit 9d117cd

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/configuration.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,7 @@ Output:
218218
To fill each [item description element](https://www.w3schools.com/xml/rss_tag_title_link_description_item.asp):
219219

220220
- If this value is set to `-1`, then the articles' full HTML content will be filled into the description element.
221+
- be careful: if set to `0` and there is no description, the feed's compliance is broken (an item must have a description)
221222
- Otherwise, the plugin first tries to retrieve the value of the keyword `description` from the [page metadata].
222223
- If the value is non-negative and no `description` meta is found, 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.
223224

@@ -227,6 +228,20 @@ Default: `150`
227228

228229
----
229230

231+
#### Abstract delimiter
232+
233+
Used to fill each [item description element](https://www.w3schools.com/xml/rss_tag_title_link_description_item.asp):
234+
235+
- If this value is set to `-1`, then the full HTML content will be filled into the description element.
236+
- Otherwise, the plugin first tries to retrieve the value of the key `description` from the page metadata.
237+
- If the value is non-negative and no `description` meta is found, then the plugin retrieves the first number of characters of the page content defined by this setting. Retrieved content is the raw markdown converted rougthly into HTML (i.e. without extension, etc.).
238+
239+
`abstract_delimiter`: string to mark .
240+
241+
Default: `<!-- more -->`
242+
243+
----
244+
230245
### Item categories
231246

232247
`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)