Commit Graph

32 Commits

Author SHA1 Message Date
CJ Pokowitz e5d5548ca0 Merge pull request 'Remove all the links that mention github in theme.toml + Fix Documentation' (#32) from fbievan/hugo-theme-readable:pr into main
Reviewed-on: https://codeberg.org/Freedom-to-Write/hugo-theme-readable/pulls/32
2024-06-19 19:08:45 +00:00
Evan G. 7fbbdd1c38
Remove all the links that mention github in theme.toml + Fix Documentation 2024-06-19 14:01:47 -05:00
CJ Pokowitz 69ba81d35d Merge pull request 'Fix Starter template link' (#27) from fbievan/hugo-theme-readable:readme-fix into main
Reviewed-on: https://codeberg.org/Freedom-to-Write/hugo-theme-readable/pulls/27
2024-06-19 00:25:25 +00:00
Evan G. 5365462844
Fix Starter template link 2024-06-18 19:22:34 -05:00
benjaminhollon d6c39b9b51 Update README to reflect move to Codeberg 2024-06-18 21:47:27 +00:00
Evan G 079b946fd6
Change Footer logic to account for .Site.Copyright and other methods (#24)
* Use License Variable & Format + Footer minimal

* Update Footer Logic
2024-06-13 13:50:33 -05:00
Robert Lützner affe4cced4
Skip prereleases of readable.css in the CI workflow (#21)
Until now the algorithm would assume that the latest release on
Codeberg is always a final release.

There is the very real possibility of prereleases, which we've learned
today, but we can easily use jq to filter these out.

This relates to #19 and fixes #20.
2024-02-26 20:49:12 -06:00
Robert Lützner f25e4d2ec8
Add missing p tag in aside shortcode definition (#18)
This fixes an issue where an `<aside>` element with a single line would
look really weird and boxed in, compared to an `<aside>` element with
multiple lines.

This has been bugging me for a while and I finally looked up how
Benjamin Hollon handles this on his blog. Here's a good example:

https://benjaminhollon.com/musings/wireless-is-a-lie/

. When compared with my own blog, I noticed the additional `<p>` tag in
Ben's code and everything became clear. If we have multiple lines, Hugo
will automatically introduce paragraphs and the formatting will be
correct. For a single line however, Hugo would assume that it was part
of the content surrounding it. That's why the surrounding box of an
`<aside>` element with a single line would look squashed.
2024-02-16 12:59:36 -06:00
Eamon Caddigan 069a59202f feat: Added `hook_head_end.html` to head
This makes it easier for theme users to add elements to the head. A file
located at layouts/partials/hook_head_end.html in the site folder will
override the (empty) `hook_head_end.html` in the theme.
2023-08-07 19:22:51 -07:00
CJ 304b5c0536 Merge commit '37c9ef6b0d7ec7d48b4f2c80708ada5c016c256b' of https://git.eamoncaddigan.net/hugo-theme-readable 2023-08-06 01:40:56 -05:00
Eamon Caddigan 37c9ef6b0d Displaying update time on single posts 2023-07-20 20:04:15 -07:00
Alice bbea1befdb
Use relative path for CSS (#16)
We should use a relative path for the CSS URL for sites that do not run from the root path (eg. https://example.com/mywebsite)
2023-05-21 13:22:50 -05:00
Robert Lützner 749aee44a0
Docs: Add configuration.md explaining the theme's parameters (#17) 2023-05-21 13:22:36 -05:00
Robert Lützner 8678494542
feat: add a shortcode for 'video' (#10)
This shortcode will add a video element embedded in a `<figure>` with an
optional `<figcaption>`.

This fixes #1.
2023-05-17 20:14:46 -05:00
Robert Lützner bbbc85d824
feat: add params.navbar_style to config to select a style for the navbar (#14)
This is a new feature in readable.css 1.1.0. The new version of
readable.css defaults to a navbar without animations, but to stay
compatible with older releases of this theme, we default to "classy"
instead which is the animated navbar.

The new navbar styles also look better without wrapping the elements
inside a `<span>`, so we make that conditional and only apply it when
the "classy" style is chosen.
2023-05-17 20:13:27 -05:00
Robert Lützner e0098cfafd
CI: Add GitHub workflow to check for readable.css updates (#15)
This adds a workflow and accompanying script to update readable.css. The
script gets the latest tag version from the readable.css repository on
codeberg.org and compares it to the currently used version. If the
versions don't match up, we download readable.css and readable.min.css
from Codeberg and update layouts/partials/head.html.
2023-05-17 20:10:19 -05:00
Benjamin Hollon f3327bc67c
Update to readable.css v1.1.0 (#13)
* Update to readable.css v1.1.0

data-style="classy" was also added to the <nav> element to preserve the
same style as the previous default.

* Use minified version of readable.css to save bandwidth

The readable.css file is kept for readability sake of people using this
template.

---------

Co-authored-by: Benjamin Hollon <me@benjaminhollon.com>
2023-05-02 16:15:28 -05:00
Robert Lützner bcd26f888b
docs: add development.md with a section on how to add a fork as a remote (#11) 2023-02-27 10:42:32 -06:00
Robert Lützner f3247c7ede
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.
2023-02-24 20:54:51 -06:00
Robert Lützner 80cd7cf8f1
feat: add 'aside' as a shortcode (#6)
The README has been updated to show a code example of both, including an
exemplary screenshot.

Since Hugo 0.55, we have to use `markdownify` in shortcodes that contain
HTML elements. At least we have to, if we want to render markdown code
inside the HTML element.

To use the `<aside>` element, we have to wrap our content in an
`<article>` tag.

This fixes #4.

Co-authored-by: Robert Lützner <robert.luetzner@iternity.com>
2023-02-23 14:04:33 -06:00
Robert Lützner 82e5f2ccab
fix: make tag links relative to the root of the page (#8)
Previously when we clicked on a tag link, it would append the path to
where we currently were, e.g. clicking "tag" on a post in the `/posts/`
lists, would send us to `/posts/tags/tag` instead of `/tags/tag`.

This fixes #7.

Co-authored-by: Robert Lützner <robert.luetzner@iternity.com>
2023-02-23 14:01:33 -06:00
Robert Lützner 473add39bd
feat: load favicon if configured via params.favicon (#5)
This will display a favicon for the website. Favicons are cute little
icons that will show up on tabs in your browser, e.g. GitHub's mascot.
They can easily be generated by using online tools, e.g.

https://realfavicongenerator.net/

The resulting package only has to be downloaded and extracted into the
'static' directory of a Hugo website that is using this theme.

The path can then be set as follows in the config.yml:

```yaml
params:
  favicon: favicon.ico
```

This fixes #3.

Co-authored-by: Robert Lützner <robert.luetzner@iternity.com>
2023-02-22 12:59:35 -06:00
cjtheham 18e9cc19ea feat: update to v1.0.1 2023-02-16 13:51:44 -06:00
cjtheham 269415bf42 fix: render image 2023-02-16 13:50:05 -06:00
cjtheham 663aa7367b feat: rss feed to footer 2023-02-15 10:50:25 -06:00
cjtheham 4108b8dec3 fix: add meta description 2023-02-14 16:38:42 -06:00
cjtheham 18847fc3a3 fix: accessibility lang 2023-02-14 16:27:52 -06:00
cjtheham 1012b37cb2 quick README typo fixes 2023-02-13 13:26:04 -06:00
cjtheham f348645be9 updated documentation 2023-02-13 13:25:06 -06:00
cjtheham 4f04124938 remove unused file 2023-01-30 13:30:46 -06:00
cjtheham e27fbc792d old work pushed 2023-01-30 13:14:33 -06:00
CJ dad292e2fd
Initial commit 2023-01-30 13:11:19 -06:00