fbievan
/
hugo-theme-readable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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.
This commit is contained in:
Robert Lützner 2023-02-25 02:54:51 +00:00 committed by GitHub
parent 80cd7cf8f1
commit f3247c7ede
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -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.