hugo-theme-readable

commit f3247c7ede8379c6eeee3c6128a565269a24fd1d
parent 80cd7cf8f1a96874a31b1adee321e11ec825bd07
Author: Robert Lützner <robert.luetzner@pm.me>
Date:   Sat, 25 Feb 2023 02:54:51 +0000

docs: clarify the intended use of the 'aside' shortcode (#9)

The initial statement was wrong. There's no preferred way of doing
things.

Blockquotes are meant to hold actual quotes, whereas the aside element
can be used to signify content that is slightly off-topic in regards to
the rest of the post.
Diffstat:
M
README.md
 | 
4
+++-

1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -30,7 +30,9 @@ Freedom to Write has provided some awesome guides on writing HTML that works aut
 
 ### aside
 
-readable.css prefers the `<aside>` HTML element over blockquotes. This theme supports both.
+You can use the `aside` shortcode to signify content that is slightly off-topic in regard to the rest of the post.
+
+Here's how it compares to a blockquote:
 
 ```text
 > This is a blockquote.