From ab2864a843f24ebd42763cfb3155f5e1f6730635 Mon Sep 17 00:00:00 2001 From: recanman <29310982+recanman@users.noreply.github.com> Date: Tue, 2 Jul 2024 15:08:59 -0700 Subject: [PATCH] docs: add readme and example config --- README.md | 28 +++++++++++++++++++ config.toml.example | 66 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 94 insertions(+) create mode 100644 README.md create mode 100644 config.toml.example diff --git a/README.md b/README.md new file mode 100644 index 0000000..0908f39 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +## Revuo XMR Theme + +The Revuo XMR theme is a customized theme for the Revuo Monero newsletter. + +[Emerald](https://github.com/rottenwheel/revuo-monero-theme/) is the theme used by Revuo. It is a minimal and mobile-first blog theme, originally for Jekyll, ported to Hugo by [recanman](https://github.com/recanman). + +## Setup & usage + +Make sure you have Go and Hugo installed. If not, follow the instructions on the [Hugo website](https://gohugo.io/getting-started/installing/). + +To use the Revuo XMR theme, clone the repository as a submodule and add it to your Hugo site: + +```bash +git submodule add https://github.com/rottenwheel/revuoxmrtheme.git themes/revuo-xmr +``` + +Then, add the theme to your site's configuration file: + +```toml +theme = "revuo-xmr" +``` + +## Customization + +Please see [config.toml.example](./config.toml.example) for an example configuration file. You can copy this file to your site's root directory and rename it to `config.toml`. + +## License +Revuo Monero is released under GNU Affero General Public License v3.0. See [LICENSE](./LICENSE) for more information. diff --git a/config.toml.example b/config.toml.example new file mode 100644 index 0000000..4c00084 --- /dev/null +++ b/config.toml.example @@ -0,0 +1,66 @@ +baseURL = 'https://revuo-xmr.com/' +languageCode = 'en-us' +title = 'Revuo Monero' +description = 'Weekly and Quarterly Monero Newsletter' +disablePathToLower = true +canonifyURLs = true +enableRobotsTXT = true +theme = 'revuo-xmr' + +[sitemap] + changefreq = "weekly" + priority = 0.5 + +[imaging] +quality = 50 + +[params] +dateFormat = "02 Jan 2006" + +nav_links = [ + { title = "Revuo Weekly", link = "/" }, + { title = "Revuo Periodical", link = "/periodicals" }, + { title = "Source Code & Licenses", link = "/source" }, + { title = "Support Revuo", link = "/support" } +] + +right_icons = [ + { title = "Support", link = "/support", external = false, icon = "donate.png", icon_alt = "Donate" }, + { title = "ATOM Feed", link = "/atom.xml", external = true, icon = "rss_1.png", icon_alt = "ATOM Feed" }, +] + +mirrors = [ + { title = "Onion", link = "http://revuo75joezkbeitqmas4ab6spbrkr4vzbhjmeuv75ovrfqfp47mtjid.onion/", icon = "tor.png", icon_alt = "Tor" }, + { title = "I2P", link = "http://qve7i3ke5h2mbbyphd7agmh5awzcwulvrvghjvhndkagdbi4mkcq.b32.i2p/", icon = "itoopie.png", icon_alt = "I2P" }, +] + +bottom_nav_icons = [ + { title = "Nostr", link = "https://primal.net/p/npub1tn8spk9zhxrctg2qym3gj8r7eq2wk6z3phrl8304wc54vt9qam4qvzw6jx", icon = "nostr-icon.png", icon_alt = "Nostr" }, + { title = "x.com", link = "https://xcancel.com/revuoxmr", icon="xcom-icon.png", icon_alt = "x.com" }, + { title = "XMPP MUC", link = "xmpp:revuo-monero@conference.jabbers.one?join", icon = "xmpp.png", icon_alt = "XMPP MUC" }, + { title = "Matrix Room", link = "https://matrix.to/#/#revuo:monero.social", icon = "matrix.png", icon_alt = "Matrix Room" }, +] + +[params.author] +name = "rottenwheel" +monero_address = "89Esx7ZAoVcD9wiDw57gxgS7m52sFEEbQiFC4qq18YZy3CdcsXvJ67FYdcDFbmYEGK7xerxgmDptd1C2xLstCbgF3RUhSMT" +monero_qr = "img/qr.jpg" + +[params.logo] +icon = "revuo-monero-logo.png" +icon_alt = "Revuo Monero Logo" + +[params.nav_footer] +title = "Monero Website" +link = "https://www.getmonero.org/" + +[params.sponsor] +introduction = "Infrastructure sponsored by" +link = "https://www.digilol.net" +icon = "digilol.png" +icon_alt = "Digilol" + +[markup] + [markup.goldmark] + [markup.goldmark.renderer] + unsafe = true \ No newline at end of file