wezm/rsspls.7bit.org
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update docs for 0.9.0

Browse source
This commit is contained in:
Wesley Moore 2024-07-08 13:52:55 +10:00
parent 32f8335214
commit 94431c7178
No known key found for this signature in database
2 changed files with 21 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
config.toml
View file

@ -9,8 +9,8 @@ compile_sass = false
# Whether to build a search index to be used later on by a JavaScript library
build_search_index = false
generate_feed = true
feed_filename = "index.xml"
generate_feeds = true
feed_filenames = ["index.xml"]
theme = "juice"

20
content/documentation.md
View file

@ -183,6 +183,11 @@ Optional output directory to write the feeds to. If not specified it must be
supplied via the `--output` command line option. Directory will be created if
it does not exist.
Tilde expansion is performed on the path in the config file. This allows you to
refer to the home directory of the user running `rsspls`. For example,
`~/Documents/rsspls` could be used to place the output in your `Documents`
folder.
### proxy
Optional proxy address. If specified, all requests will be routed through it.
@ -235,7 +240,20 @@ recommended to specify the `link` selector explicitly.
### feed.config.summary
Optional CSS selector relative to `item` that will supply the content of the RSS item.
Optional CSS selector relative to `item` that will supply the content of the
RSS item. This value may be a single CSS selector, or an array of CSS
selectors.
The CSS selectors may also include a comma separated list of elements to match.
For example: `summary = "p, blockquote"` will match `p` or `blockquote`
elements, adding them to the RSS feed in the order then are encountered in the
HTML document.
The array form of `summary` allows the order of the matched elements to be
controlled, enabling elements to be added to the feed in a different order to
the source HTML document. For example, `summary = ["p", "blockquote"]` causes
`rsspls` to make a pass over the source HTML document, adding `p` elements to
the feed, followed by a pass adding `blockquote` elements to the feed.
### feed.config.date