Compare commits

...

6 Commits

4 changed files with 18 additions and 9 deletions

View File

@ -12,13 +12,13 @@ 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://codeberg.org/Freedom-to-Write/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.
If you don't have an existing site, feel free to use the provided [starter template](https://codeberg.org/Freedom-to-Write/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/).

View File

@ -2,7 +2,7 @@
## Adding your fork as an additional Git remote to a hugo-theme-readable Git submodule
The easiest way to test your changes is with an existing Hugo website that already uses this theme. You can use your own or checkout the [starter template](https://github.com/cjtheham/hugo-starter-readable).
The easiest way to test your changes is with an existing Hugo website that already uses this theme. You can use your own or checkout the [starter template](https://codeberg.org/Freedom-to-Write/hugo-starter-readable).
The following steps show you how to add your fork as an additional Git remote to the checked out Git submodule.
@ -16,7 +16,7 @@ git submodule update
cd themes/readable/
# Add your fork as the remote 'fork'.
git remote add fork git@github.com:<your-username>/hugo-theme-readable.git
git remote add fork git@codeberg.org:<your-username>/hugo-theme-readable.git
# Create a new branch.
git checkout -b my-change

View File

@ -1,3 +1,12 @@
<p><a href="/policies/privacy/">Privacy Policy</a> | <a href="/policies/cookies/">Cookie Policy</a> | <a href="/policies/terms/">Terms of Use</a></p> <!-- We like putting links in a paragraph separated by pipe ("|") characters -->
<p>© 2023 {{ $.Site.Params.author }}</p> <!-- While not legally required, it's nice to put copyright and/or license info here. Also, it looks nice to break up the links with a line of text -->
{{ if .Site.Params.footer.minimal | not }}
<p>
<a href="/policies/privacy/">Privacy Policy</a> | <a href="/policies/cookies/">Cookie Policy</a> | <a href="/policies/terms/">Terms of Use</a>
</p>
{{ end }}
{{ with .Site.Copyright }}
<p>{{ now.Format "2006" }} © {{ . | markdownify }}</p>
{{ else }}
<p>{{ now.Format "2006" }} © {{ .Site.Params.author }} {{ with .Site.Params.License }} - {{ . | markdownify }} {{ end }} </p> <!-- While not legally required, it's nice to put copyright and/or license info here. Also, it looks nice to break up the links with a line of text -->
{{ end }}
<a href={{ $.Site.Params.Mastodon }} rel="me" target="blank">Mastodon</a> | <a href="/contact/">Contact Me</a> | <a href="/posts/index.xml">RSS Feed</a></p> <!-- This is the kind of thing people look for in footers: contact info and legal info. Make sure you include both! -->

View File

@ -3,9 +3,9 @@
name = "Readable"
license = "Unlicense"
licenselink = "https://github.com/cjtheham/hugo-theme-readable/blob/main/LICENSE"
licenselink = "https://codeberg.org/Freedom-to-Write/hugo-theme-readable/src/branch/main/LICENSE"
description = "A theme using Freedom to Write's Readable.css"
homepage = "https://github.com/cjtheham/hugo-theme-readable"
homepage = "https://codeberg.org/Freedom-to-Write/hugo-theme-readable"
tags = []
features = []
min_version = "0.41.0"