From 36110a0c55ff5f22e22564fac24c7641edd238d4 Mon Sep 17 00:00:00 2001 From: fbievan Date: Mon, 20 May 2024 14:50:59 -0500 Subject: [PATCH] Updated README Did the Following - Removed Necessary Documentation that can be referred to at the orginal project - Credited the Authors of the numerous projects used --- README.md | 51 ++++++++++----------------------------------------- 1 file changed, 10 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index b7800f6..c7a9a7f 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Readable is a theme for the static-site generator [Hugo](https://gohugo.io/) usi Shoutout to [Benjamin Hollon](https://benjaminhollon.com/) for his amazing work building this CSS framework and making it so simple to use. -Want to check out a demo? (coming soon) +**This is a fork of the project [hugo-theme-readable](https://github.com/cjtheham/hugo-theme-readable)** ![demo image](/docs/demo_image.png) @@ -12,58 +12,27 @@ Want to check out a demo? (coming soon) 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 https://github.com/cjtheham/hugo-theme-readable themes/readable` +`git submodule add https://git.fbievan.live/fbievan/hugo-theme-readable 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](https://github.com/cjtheham/hugo-starter-readable) to quickly get your website online. - For more information on starting a Hugo website and using custom themes, refer to the [Hugo documentation](https://gohugo.io/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](https://codeberg.org/Freedom-to-Write/readable.css/wiki/Overall-Structure). For some neat tips that may make life easier working with this style sheet, read [Quick Tips](https://codeberg.org/Freedom-to-Write/readable.css/wiki/Quick-Tips). -## Shortcodes -### aside +## The rest +As mentioned, This is a fork of [hugo-theme-readable](https://github.com/cjtheham/hugo-theme-readable), and will continue to cherry-pick commits from the upstream. I also commit to pushing certain things I think work with the upstream project, to the upstream. -You can use the `aside` shortcode to signify content that is slightly off-topic in regard to the rest of the post. +This is very much a opinonized theme for my site, and you can use it for yours, I however ask that you credit me as I credit Benjamin, and CJ for the work done on this project. -Here's how it compares to a blockquote: +Without Benjamin Hollon or C.J this theme wouldn't exist. -```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. -{{}} -``` - -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="https://test-videos.co.uk/vids/bigbuckbunny/mp4/av1/1080/Big_Buck_Bunny_1080_10s_5MB.mp4" 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](https://www.w3schools.com/html/html5_video.asp#table1). - -## 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](https://codeberg.org/Freedom-to-Write/readable.css) 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)](https://codeberg.org/Freedom-to-Write/readable.css/wiki/Unofficial-Related-Projects-%28that-are-awesome%29). Go mention [@freedomtowrite@fosstodon.org](https://fosstodon.org/@freedomtowrite) to be featured there! +Projects used: +- [hugo](https://gohugo.io/) created by [Bep](https://bep.is/en/) +- [Readable.css](https://codeberg.org/Freedom-to-Write/readable.css) created by [Benjamin Hollon](https://benjaminhollon.com/) +- [Hugo Readable Theme](https://github.com/cjtheham/hugo-theme-readable) created by [C.J](https://github.com/cjtheham) \ No newline at end of file