{"id":14981470,"url":"https://github.com/chringel21/chringel-hugo-theme","last_synced_at":"2025-10-29T05:31:59.683Z","repository":{"id":38353788,"uuid":"440856913","full_name":"chringel21/chringel-hugo-theme","owner":"chringel21","description":"chringel - Privacy focused theme for Hugo","archived":false,"fork":false,"pushed_at":"2023-05-10T16:35:21.000Z","size":13278,"stargazers_count":36,"open_issues_count":2,"forks_count":8,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-09-29T05:41:32.372Z","etag":null,"topics":["blog-theme","hugo","hugo-theme","indieweb","ionicons","isso","isso-comments","microformats2","privacy","resume","static-site-generator","tailwindcss","theme","umami","umami-analytics","webmentions"],"latest_commit_sha":null,"homepage":"https://chringel21.github.io/chringel-hugo-theme/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chringel21.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-12-22T12:52:08.000Z","updated_at":"2024-07-01T11:42:50.000Z","dependencies_parsed_at":"2024-06-19T11:27:25.287Z","dependency_job_id":"ba5170c1-2a46-40dd-b3c0-ff48857da255","html_url":"https://github.com/chringel21/chringel-hugo-theme","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chringel21%2Fchringel-hugo-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chringel21%2Fchringel-hugo-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chringel21%2Fchringel-hugo-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chringel21%2Fchringel-hugo-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chringel21","download_url":"https://codeload.github.com/chringel21/chringel-hugo-theme/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219858322,"owners_count":16556048,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blog-theme","hugo","hugo-theme","indieweb","ionicons","isso","isso-comments","microformats2","privacy","resume","static-site-generator","tailwindcss","theme","umami","umami-analytics","webmentions"],"created_at":"2024-09-24T14:03:37.378Z","updated_at":"2025-10-29T05:31:53.637Z","avatar_url":"https://github.com/chringel21.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# chringel - Privacy focused theme for Hugo 🕵️\n\nBased on the **awesome** [Hugo Starter Theme with Tailwind CSS](https://github.com/dirkolbrich/hugo-theme-tailwindcss-starter). Go check it out! 🚀\n\n![chringel](https://user-images.githubusercontent.com/6780575/155966743-3c1a3a47-d6e8-42b9-97e4-d862e8edb1e3.png)\n\nThis theme was created with privacy in mind. By default, Disqus and Google Analytics are disabled, but you are free to use them, if you want. Instead this theme comes with configuration options for [Isso](https://posativ.org/isso/) and [umami](https://umami.is/).\n\n## Quickstart\n\n### For a new site\n\n```bash\n# Create a new site\nhugo new site my-site\n\n# Change into your themes folder\ncd my-site/themes\n\n# Clone this theme\ngit clone https://github.com/chringel21/chringel-hugo-theme.git\n\n```\n\n- Don't forget to edit your `config.toml` to use your new theme\n\n```toml\n# config.toml\ntheme = \"chringel-hugo-theme\"\n```\n\n### Create a new post\n\nIncluded is an [`archetype`](./archetypes/post-bundle/) to help you get started with creating content. It's a [post bundle](https://gohugo.io/content-management/page-bundles/#leaf-bundles). Create it with:\n\n```shell\nhugo new --kind post-bundle post/my-post\n```\n\n### Create a new note\n\nIf you want to dive into the IndieWeb, chances are you want to create notes. They are like tweets/toots/status updates, or can contain comments, likes and reposts. Take a look at the [`archetype`](./archetypes/notes.md). I would recommend creating notes like this:\n\n```shell\nhugo new notes/`date +'%Y/%m/%d/%H%M'`.md\n```\n\nThis will create a note in your content folder at `content/notes/YYYY/mm/dd/HHMM.md`.\n\n## Features\n\n- 🌝 /🌚 Automatic dark mode based on device setting\n- 💬 Isso commenting server similar to Disqus ([self-hosted](https://posativ.org/isso/docs/install/))\n- 📈 umami - simple, easy to use, web analytics solution ([self-hosted](https://umami.is/docs/install))\n- 🐦 SVG (social) icons powered by [ionicons](https://ionic.io/ionicons), currently Twitter, Github, Mastodon and RSS are available, but more can be downloaded with a simple shell script\n- 🧑‍💻 Syntax highlighting with copy function\n- 🔗 Deeplinks to headings in a blog post\n- 📄 Resume from JSON data based on [JsonResume schema](https://jsonresume.org/schema/)\n- 🕸 [IndieWeb](https://indiewebify.me/) implementation of [microformats2](http://microformats.org/) `h-card` and `h-entry`\n\n## Full `config.toml` example\n\n```toml\ntitle = \"chringel - Privacy focused theme for Hugo\"\nlanguageCode = \"en-us\"\nbaseurl = \"http://example.com/\"\ntheme = \"chringel\"\nthemesDir = \"../..\"\n\nauthor = \"Christian Engel\"\ncopyright = \"Copyright © 2022, Christian Engel, all rights reserved.\"\n\npluralizelisttitles = false\npaginate = 10\nenableEmoji = true\n\n[Params]\n    name = \"chringel\"\n    description = \"A privacy focused theme for Hugo\"\n\n    github_user = \"chringel21\"\n    github_repo = \"https://github.com/chringel21/chringel-hugo-theme\"\n    github_banner = true\n\n    favicon = \"favicon.ico\"\n\n    # Title to be displayed in header\n    headerTitle = 'chringel@dev: ~/$'\n    # User image\n    titleImage = 'images/index.png'\n    # Copyright text displayed in footer\n    footerCopyrightText = 'Christian Engel 2022'\n\n# Favicons config\n# Get your favicons from https://realfavicongenerator.net/\n# Put them in the 'static' folder\n[Params.favicons]\n  appleTouchIcon = '/apple-touch-icon.png'\n  icon32 = '/favicon-32x32.png'\n  icon16 = '/favicon-16x16.png'\n  manifest = '/site.webmanifest'\n  maskIcon = '/safari-pinned-tab.svg'\n  msApplicationTileColor = '#5bbad5'\n  themeColor = '#ffffff'\n\n# Isso configuration\n# https://posativ.org/isso/docs/configuration/client/\n[Params.isso]\n  enabled = true\n  data = \"https://comments.exmaple.com/\"\n  id = \"thread-id\"\n  css = true\n  lang = \"en\"\n  replyToSelf = true\n  requireAuthor = true\n  requireEmail = false\n  avatar = true\n  avatar-bg = \"#f0f0f0\"\n  jsLocation = \"https://comments.example.com/js/embed.min.js\"\n\n# Umami configuration\n# https://umami.is/docs/install\n[Params.umami]\n  enabled = true\n  websiteId = \"1234567-abcd-efgh-0000-abcdefg1234\"\n  jsLocation = \"https://analytics.example.com/umami.js\"\n\n# microformat2 h-card configuration\n# All params except 'fullName' are optional\n[Params.hcard]\n  avatar = \"/images/index.png\"\n  fullName = \"Christian Engel\"\n  pronouns = [ \"he\", \"him\" ]\n  nickname = \"chringel\"\n  showLocation = true\n  city = \"My Town\"\n  region = \"My State\"\n  country = \"My Country\"\n\n[Params.indieweb]\n  authorizationEndpoint = \"https://indieauth.com/auth\"\n  tokenEndpoint = \"https://tokens.indieauth.com/token\"\n\n[Params.webmention]\n  webmentionUrl = \"https://webmention.io\"\n  webmentionEndpoint = \"/webmention\"\n  webmentionPingbackEndpoint = \"/xmlrcp\"\n\n# Social icons to be displayed on the front page\n[[menu.social]]\n  name = \"GitHub\"\n  url = \"https://github.com/chringel21\"\n\n[[menu.social]]\n  name = \"Twitter\"\n  url = \"https://twitter.com/DeEgge\"\n\n[[menu.social]]\n  name = \"RSS\"\n  url = \"http://example.com/index.xml\"\n\n# To make purging of CSS classes work in production\n[build]\n  writeStats = true\n\n# syntax highlight settings\n[markup]\n  [markup.highlight]\n    style = \"dracula\"\n```\n\n## Development\n\nMake sure to install `postcss-cli` and `autoprefixer` globally in your environment, as Hugo Pipe’s PostCSS requires it. This is mentioned in the [Hugo Docs](https://gohugo.io/hugo-pipes/postcss/).\n\n```bash\nnpm install -g postcss-cli\nnpm install -g autoprefixer\n```\n\nChange into the theme's folder and install the dependencies.\n\n```bash\ncd themes/chringel\nnpm install\n```\n\nMake sure to use a minimum Hugo version of v0.69.0 and above.\n\nSet the `writeStats` option in your Hugo `config` file, so that purging of CSS classes works in production. See `/exampleSite/config.toml` as a guideline.\n\n```toml\n[build]\n  writeStats = true\n```\n\nRun the `hugo server` using the following command:\n\n```bash\nHUGO_THEME_DEVELOPMENT=true hugo server --disableFastRender --buildDrafts --buildFuture\n```\n\nThe theme will pick up the environment variable and use Hugo's [PostCSS pipe](https://gohugo.io/hugo-pipes/postcss/) to build CSS files.\n\nCheck out the [Tailwind CSS docs](https://tailwindcss.com/docs/installation).\n\n### Building shippable CSS\n\n```bash\npostcss assets/css/styles.css --config assets/css/postcss.config.js \u003e assets/css/build.css\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchringel21%2Fchringel-hugo-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchringel21%2Fchringel-hugo-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchringel21%2Fchringel-hugo-theme/lists"}