katharsis 1.0.0-canary.30

CLI tool for generating RSS feeds.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

# NOTE:
# You can refer to the
# [RSS 2.0 at Harvard Law](https://cyber.harvard.edu/rss/rss.html)
# for more detailed documentation.

[rss]
# The title of the website
title = "Your Website Title"
# A description of the website
description = "Your Website Description"
# The main URL of the website
# NOTE:
# The `rss.site_url` property should not include a trailing slash
# (for example, `https://example.com` rather than `https://example.com/`).
site_url = "https://example.com"
# Path to the channel's logo
# NOTE:
# The `rss.image` property is relative to the `rss.site_url`
# (for example, `favicon.png` corresponds to `https://example.com/favicon.png`).
image = "favicon.png"
# Copyright information
copyright = "© Year Your Name"
# Preferred language
language = "en"
# Path to the local output RSS file
# NOTE:
# The `rss.output` property specifies the path relative to the working directory
# (for example, `rss.xml` corresponds to `./rss.xml`).
output = "rss.xml"

[article]
# The tag containing the article's title
title = "h1"
# The tag or attribute containing the article's description
description = "[data-description]"
# The HTML files that needs to be parsed
# NOTE:
# The `article.input` property corresponds to the file stem (`*`),
# which is the same as the article's URL slug.
input = "articles/*.html"
# Information about the article's author
author = { name = "Your Name", email = "Your Email" }
# The relative prefix for the article's URL
prefix = "articles"
# The tag or attribute containing the article's content
content = "[data-content]"
# The tag containing the article's publication date
# NOTE:
# The `article.date` property's tag must include a
# [datetime](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/time)
# attribute, and the attribute value must follow the `%Y-%m-%d` format.
date = "time"
# The image files to be used as the article cover
# NOTE: The `article.image` property's folder name (`**`) must match the article's URL slug.
image = "articles/**/image.png"
# Whether to sort articles by their publication date
sort = true