From 94431c7178b8a523aa769c5aa10a7824858e021f Mon Sep 17 00:00:00 2001 From: Wesley Moore Date: Mon, 8 Jul 2024 13:52:55 +1000 Subject: [PATCH] Update docs for 0.9.0 --- config.toml | 4 ++-- content/documentation.md | 20 +++++++++++++++++++- 2 files changed, 21 insertions(+), 3 deletions(-) diff --git a/config.toml b/config.toml index 9e83064..34d24fe 100644 --- a/config.toml +++ b/config.toml @@ -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" diff --git a/content/documentation.md b/content/documentation.md index cde1fbf..321104e 100644 --- a/content/documentation.md +++ b/content/documentation.md @@ -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