39 lines
2.4 KiB
Markdown
39 lines
2.4 KiB
Markdown
# hugo-theme-readable
|
|
|
|
Readable is a theme for the static-site generator [Hugo](https://gohugo.io/) using the [readable.css](https://readable-css.freedomtowrite.org/) framework built by [Freedom to Write](https://freedomtowrite.org/).
|
|
|
|
Shoutout to [Benjamin Hollon](https://benjaminhollon.com/) for his amazing work building this CSS framework and making it so simple to use.
|
|
|
|
**This is a fork of the project [hugo-theme-readable](https://codeberg.org/Freedom-to-Write/hugo-theme-readable)**
|
|
https://codeberg.org/Freedom-to-Write/hugo-theme-readable
|
|
|
|
|
|
## 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 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'`
|
|
|
|
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).
|
|
|
|
|
|
## The rest
|
|
As mentioned, This is a fork of [hugo-theme-readable](https://codeberg.org/Freedom-to-Write/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.
|
|
|
|
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.
|
|
|
|
Without Benjamin Hollon or C.J this theme wouldn't exist.
|
|
|
|
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://codeberg.org/Freedom-to-Write/hugo-theme-readable) created by [C.J](https://github.com/cjtheham)
|