forked from getzola/zola
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add author to documentation for config.toml * Add explanation of how author is used for feeds
- Loading branch information
Showing
2 changed files
with
20 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,6 +23,20 @@ check the documentation for the specifications for Atom 1.0 and RSS 2.0 in | |
|
||
**Only pages with a date will be available.** | ||
|
||
The author in the feed is set as | ||
- The first author in `authors` set in the | ||
[front matter](@/documentation/content/page.md#front-matter) | ||
- If that is not present it falls back to the `author` in the | ||
[Configuration](@/documentation/getting-started/configuration.md) | ||
- If that is also not preset it is set to `Unknown`. | ||
|
||
Note that `atom.xml` and `rss.xml` require different formats for specifying the | ||
author. According to [RFC 4287][atom_rfc] `atom.xml` requires the author's | ||
name, for example `"John Doe"`. While according to the | ||
[RSS 2.0 Specification][rss_spec] the email address is required, and the name | ||
optionally included, for example `"[email protected]"` or | ||
`"[email protected] (Lawyer Boyer)"`. | ||
|
||
The feed template gets five variables: | ||
|
||
- `config`: the site config | ||
|
@@ -69,3 +83,6 @@ In order to enable the tag feeds as well, you can overload the `block rss` using | |
{% endblock rss %} | ||
``` | ||
Each tag page will refer to it's dedicated feed. | ||
|
||
[atom_rfc]: https://www.rfc-editor.org/rfc/rfc4287 | ||
[rss_spec]: https://www.rssboard.org/rss-specification#ltauthorgtSubelementOfLtitemgt |