Fork of
git clone
Log | Files | Refs | README | LICENSE

commit fd2d4f92f1d71519d34ab1d45a3464af8b6e0c3e
parent 069a59202f97433ccd28d9af3ee30d3fd1b94781
Author: Eamon Caddigan <>
Date:   Thu, 27 Jul 2023 18:47:52 -0700

Updating README with warnings

Diffstat: | 77++++++++++-------------------------------------------------------------------
1 file changed, 10 insertions(+), 67 deletions(-)

diff --git a/ b/ @@ -1,69 +1,12 @@ # hugo-theme-readable -Readable is a theme for the static-site generator [Hugo]( using the [readable.css]( framework built by [Freedom to Write]( - -Shoutout to [Benjamin Hollon]( for his amazing work building this CSS framework and making it so simple to use. - -Want to check out a demo? (coming soon) - -![demo image](/docs/demo_image.png) - -## Installation - -To add this theme to an existing Hugo site, start by adding this repo as a submodule in the site's themes folder. - -`git submodule add themes/readable` - -Then, update your config file to be using the new theme. For example, if you are using config.toml, the line should become: - -`theme = 'readable'` - -If you don't have an existing site, feel free to use the provided [starter template]( to quickly get your website online. - -For more information on starting a Hugo website and using custom themes, refer to the [Hugo documentation]( - -## Usage - -Freedom to Write has provided some awesome guides on writing HTML that works automatically with the formatting of Readable. For a complete HTML page guide on writing custom pages, see [Overall Structure]( For some neat tips that may make life easier working with this style sheet, read [Quick Tips]( - -## Shortcodes - -### aside - -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. -> -> This is a default **markdown** element and supports formatting inside it. - -{{< aside >}} -This is an aside element. - -You can use **markdown** formatting inside it. -{{</ aside >}} -``` - -The above code generates the following output: - -![Comparing a blockquote to an aside. The blockquote has a thin bar on it's left, while the aside element is inside a nice box with rounded corners.](/docs/blockquote_vs_aside.png) - -### video - -You can use the `video` shortcode to embed a video player in your post. - -```text -{{< video source="" type="video/mp4" caption="Of course it's Big Buck Bunny!" >}} -``` - -![A still from an embedded video with controls in a post.](/docs/video.png) - -Sources can be remote or static content from your website. You can find the supported file types [here]( - -## Notes - -- Benjamin loves when new sites and projects pop up using the readable.css framework! - - If you've built a complete site using this theme, submit an issue to the [original repo]( with the URL of your site to be featured in the project's README. - - Projects like this and other non-website uses of the framework, such as adapting it to other static site generators, can be featured on the page [Unofficial Related Projects (that are awesome)]( Go mention []( to be featured there! +This is my fork of +[hugo-theme-readable]( for +[my personal website]( I intend to submit my +changes upstream and keep this up-to-date, but I'm maintaing this so that +it's easier to clone my website repository. + +I might force-push to `main` a lot depending on how much I modify this and +how upstream development goes, sorry if that causes anybody any trouble (I +doubt it will). If you do clone this for some reason, [I'd love to hear from +you](