This includes several breaking changes, but they’re easy to adjust for. Atom 1.0 is superior to RSS 2.0 in a number of ways, both technical and legal, though information from the last decade is hard to find. http://www.intertwingly.net/wiki/pie/Rss20AndAtom10Compared has some info which is probably still mostly correct. How do RSS and Atom compare in terms of implementation support? The impression I get is that proper Atom support in normal content websites has been universal for over twelve years, but that support in podcasts was not quite so good, but getting there, over twelve years ago. I have no more recent facts or figures; no one talks about this stuff these days. I remember investigating this stuff back in 2011–2013 and coming to the same conclusion. At that time, I went with Atom on websites and RSS in podcasts. Now I’d just go full Atom and hang any podcast tools that don’t support Atom, because Atom’s semantics truly are much better. In light of all this, I make the bold recommendation to default to Atom. Nonetheless, for compatibility for existing users, and for those that have Opinions, I’ve retained the RSS template, so that you can escape the breaking change easily. I personally prefer to give feeds a basename that doesn’t mention “Atom” or “RSS”, e.g. “feed.xml”. I’ll be doing that myself, as I’ll be using my own template with more Atom features anyway, like author information, taxonomies and making the title field HTML. Some notes about the Atom feed template: - I went with atom.xml rather than something like feed.atom (the .atom file format being registered for this purpose by RFC4287) due to lack of confidence that it’ll be served with the right MIME type. .xml is a safer default. - It might be nice to get Zola’s version number into the <generator> tag. Not for any particularly good reason, y’know. Just picture it: <generator uri="https://www.getzola.org/" version="0.10.0"> Zola </generator> - I’d like to get taxonomies into the feed, but this requires exposing a little more info than is currently exposed. I think it’d require `TaxonomyConfig` to preferably have a new member `permalink` added (which should be equivalent to something like `config.base_url ~ "/" ~ taxonomy.slug ~ "/"`), and for the feed to get all the taxonomies passed into it (`taxonomies: HashMap<String, TaxonomyTerm>`). Then, the template could be like this, inside the entry: {% for taxonomy, terms in page.taxonomies %} {% for term in terms %} <category scheme="{{ taxonomies[taxonomy].permalink }}" term="{{ term.slug }}" label="{{ term.name }}" /> {% endfor %} {% endfor %} Other remarks: - I have added a date field `extra.updated` to my posts and include that in the feed; I’ve observed others with a similar field. I believe this should be included as an official field. I’m inclined to add author to at least config.toml, too, for feeds. - We need to have a link from the docs to the source of the built-in templates, to help people that wish to alter it.
92 lines
2.2 KiB
Markdown
92 lines
2.2 KiB
Markdown
|
|
+++
|
|
title = "after-dark"
|
|
description = "A robust, elegant dark theme"
|
|
template = "theme.html"
|
|
date = 2017-11-07T17:39:37+01:00
|
|
|
|
[extra]
|
|
created = 2019-04-06T11:27:43+02:00
|
|
updated = 2017-11-07T17:39:37+01:00
|
|
repository = "https://github.com/getzola/after-dark"
|
|
homepage = "https://github.com/getzola/after-dark"
|
|
minimum_version = "0.5.0"
|
|
license = "MIT"
|
|
demo = "https://zola-after-dark.netlify.com"
|
|
|
|
[extra.author]
|
|
name = "Vincent Prouillet"
|
|
homepage = "https://www.vincentprouillet.com"
|
|
+++
|
|
|
|
# after-dark
|
|
|
|
![after-dark screenshot](https://github.com/getzola/after-dark/blob/master/screenshot.png?raw=true)
|
|
|
|
## Contents
|
|
|
|
- [Installation](#installation)
|
|
- [Options](#options)
|
|
- [Top menu](#top-menu)
|
|
- [Title](#title)
|
|
|
|
## Installation
|
|
First download this theme to your `themes` directory:
|
|
|
|
```bash
|
|
$ cd themes
|
|
$ git clone https://github.com/getzola/after-dark.git
|
|
```
|
|
and then enable it in your `config.toml`:
|
|
|
|
```toml
|
|
theme = "after-dark"
|
|
```
|
|
|
|
This theme requires your index section (`content/_index.md`) to be paginated to work:
|
|
|
|
```toml
|
|
paginate_by = 5
|
|
```
|
|
|
|
The posts should therefore be in directly under the `content` folder.
|
|
|
|
The theme requires tags and categories taxonomies to be enabled in your `config.toml`:
|
|
|
|
```toml
|
|
taxonomies = [
|
|
# You can enable/disable feeds
|
|
{name = "categories", feed = true},
|
|
{name = "tags", feed = true},
|
|
]
|
|
```
|
|
If you want to paginate taxonomies pages, you will need to overwrite the templates
|
|
as it only works for non-paginated taxonomies by default.
|
|
|
|
|
|
## Options
|
|
|
|
### Top-menu
|
|
Set a field in `extra` with a key of `after_dark_menu`:
|
|
|
|
```toml
|
|
after_dark_menu = [
|
|
{url = "$BASE_URL", name = "Home"},
|
|
{url = "$BASE_URL/categories", name = "Categories"},
|
|
{url = "$BASE_URL/tags", name = "Tags"},
|
|
{url = "https://google.com", name = "Google"},
|
|
]
|
|
```
|
|
|
|
If you put `$BASE_URL` in a url, it will automatically be replaced by the actual
|
|
site URL.
|
|
|
|
### Title
|
|
The site title is shown on the homepage. As it might be different from the `<title>`
|
|
element that the `title` field in the config represents, you can set the `after_dark_title`
|
|
instead.
|
|
|
|
## Original
|
|
This template is based on the Hugo template https://git.habd.as/comfusion/after-dark
|
|
|
|
|