emelie/zola
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Fix RSS block example in documentation (#1210)

Browse source 
This commit fixes a bug in the documentation for the feeds page which
shows how to use the RSS block to enable feed autodiscovery.

The bug used an em space character instead of a space in one part of the
code snippet. If a user were to copy the code snippet into their code as
directed, the Zola build would fail with a parse error. The em space
appears identical to a regular space in monospaced fonts, making the
error seem mysterious or incorrect.

I believe the em space was used in order to prevent the shortcode from
rendering, as the code snippet is just meant to show what the shortcode
looks like. However, it is possible to escape the shortcode so that it
renders correctly without causing confusion for the user who expects to
be able to copy and paste it.

This commit replaces the em space in both code snippets with regular
spaces and escapes the shortcodes.
This commit is contained in:
Kiyan Mair 2020-10-21 07:00:16 -04:00 committed by GitHub
parent 29b073640e
commit f5a200e64c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/content/documentation/templates/feeds/index.md
View file

@ -48,7 +48,7 @@ As an example this is how it looks like using [Firefox](https://en.wikipedia.org
You can enable posts autodiscovery modifying your blog `base.html` template adding the following code in between the `<head>` tags. You can enable posts autodiscovery modifying your blog `base.html` template adding the following code in between the `<head>` tags.
```html ```html
{% block rss %} {% block rss %}
<link rel="alternate" type="application/rss+xml" title="RSS" href="{{ get_url(path="rss.xml", trailing_slash=false) }}"> <link rel="alternate" type="application/rss+xml" title="RSS" href="{{/* get_url(path="rss.xml", trailing_slash=false) */}}">
{% endblock %} {% endblock %}
``` ```
You can as well use an Atom feed using `type="application/atom+xml"` and `path="atom.xml"`. You can as well use an Atom feed using `type="application/atom+xml"` and `path="atom.xml"`.
@ -59,7 +59,7 @@ In order to enable the tag feeds as well, you can overload the `block rss` using
```html ```html
{% block rss %} {% block rss %}
{% set rss_path = "tags/" ~ term.name ~ "/rss.xml" %} {% set rss_path = "tags/" ~ term.name ~ "/rss.xml" %}
<link rel="alternate" type="application/rss+xml" title="RSS" href="{{ get_url(path=rss_path, trailing_slash=false) }}"> <link rel="alternate" type="application/rss+xml" title="RSS" href="{{/* get_url(path=rss_path, trailing_slash=false) */}}">
{% endblock rss %} {% endblock rss %}
``` ```
Each tag page will refer to it's dedicated feed. Each tag page will refer to it's dedicated feed.