{"id":25806681,"url":"https://github.com/rustydaemon/rusty-poison","last_synced_at":"2025-02-27T20:28:44.704Z","repository":{"id":278804220,"uuid":"933351190","full_name":"RustyDaemon/rusty-poison","owner":"RustyDaemon","description":"Clean, professional, minimalistic theme for Hugo","archived":false,"fork":false,"pushed_at":"2025-02-21T19:30:14.000Z","size":253,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-21T20:22:10.586Z","etag":null,"topics":["hugo","hugo-blog-theme","hugo-theme"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RustyDaemon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2025-02-15T18:42:46.000Z","updated_at":"2025-02-21T19:30:17.000Z","dependencies_parsed_at":"2025-02-21T20:32:13.944Z","dependency_job_id":null,"html_url":"https://github.com/RustyDaemon/rusty-poison","commit_stats":null,"previous_names":["rustydaemon/rusty-poison"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RustyDaemon%2Frusty-poison","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RustyDaemon%2Frusty-poison/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RustyDaemon%2Frusty-poison/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RustyDaemon%2Frusty-poison/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RustyDaemon","download_url":"https://codeload.github.com/RustyDaemon/rusty-poison/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241056700,"owners_count":19901837,"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":["hugo","hugo-blog-theme","hugo-theme"],"created_at":"2025-02-27T20:28:43.725Z","updated_at":"2025-02-27T20:28:44.695Z","avatar_url":"https://github.com/RustyDaemon.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rusty Poison\n\n**Clean** and **professional** Hugo theme built around an excellent Poison theme by [Luke Orth](https://github.com/lukeorth/poison).\n\nIt is **tiny**. It has _no external dependencies_. No frameworks, icon packs, or Google fonts. No ads or trackers.\n\nAll the static assets for the site (JS files, CSS, and fonts) are located within the theme's _/assets/_ directory.\n\n---\n\n## Contents\n\n- [Rusty Poison](#rusty-poison)\n  - [Contents](#contents)\n  - [Installation](#installation)\n    - [As standalone theme](#as-standalone-theme)\n    - [As submodule](#as-submodule)\n    - [Apply the theme](#apply-the-theme)\n  - [Features](#features)\n    - [Light/dark mode](#lightdark-mode)\n    - [Table of contents (ToC)](#table-of-contents-toc)\n    - [Analytics](#analytics)\n    - [Series](#series)\n    - [Details](#details)\n  - [How to Configure](#how-to-configure)\n    - [The sidebar menu](#the-sidebar-menu)\n    - [The front page](#the-front-page)\n    - [Example config](#example-config)\n    - [Custom CSS](#custom-css)\n  - [License](#license)\n\n## Installation\n\nThere are two ways to install the theme:\n\n### As standalone theme\nClone the repository into your `themes` directory:\n\n```sh\ngit clone https://github.com/RustyDaemon/rusty-poison themes/rusty-poison\n```\n\n### As submodule\n\n```sh\ngit submodule add https://github.com/RustyDaemon/rusty-poison.git themes/rusty-poison\n```\n\n### Apply the theme\nSet `rusty-poison` as the default theme in your `hugo.toml` file:\n\n```toml\ntheme = \"rusty-poison\"\n```\n\n## Features\n\n### Light/dark mode\n\nDark mode is the default for first time visitors, but you can change this in your config file.\n\n\u003cp float=\"left\"\u003e\n\t\u003cimg width=\"700\" alt=\"dark mode\" src=\"https://github.com/user-attachments/assets/52140006-4989-49aa-b710-69169b3c9bb2\" /\u003e\n\t\u003cimg width=\"700\" alt=\"light mode\" src=\"https://github.com/user-attachments/assets/06df74c4-0ce9-4796-9e41-e28d994747db\" /\u003e\n\u003c/p\u003e\n\n### Table of contents (ToC)\n\nProvide a floating table of contents for large screens.\n\nIf you prefer not to display a table of contents, you can disable them site-wide in your `hugo.toml` file.\n\n```toml\n[params]\n    hideToc = true\n```\n\nAlternatively, you can choose to disable it on a per-post basis by putting the flag in the frontmatter of an individual post.\n\n```toml\ntitle = \"Simple post with no ToC\"\ndate = 2025-02-16\nhideToc = true\ntags = [\"go\"]\n```\n\n### Analytics\n\nRusty Poison support [Plausible](https://plausible.io) and [Umami](https://umami.is/).\n\nTo enable analytics, add these lines to your `hugo.toml` file:\n\n```toml\n[params]\n    plausible = true\n    plausible_domain = \"myblog.com\"\n    plausible_script = \"https://plausible.myblog.com/js/script.js\"\n```\n\n```toml\n[params]\n    umami = true\n    umami_script = \"https://cloud.umami.is/script.js\"\n    umami_website_id = \"website_id\"\n```\n\nThis will insert the necessary code in the `\u003chead\u003e` on each page and will allow your Plausible and/or Umami instance to collect a limited set of data on your users.\n\nFor reference, the configuration above will add the following code to each page.\n\n**Note**: _Enabling analytics will add external dependencies._\n\n### Series\n\nUse series, if you want to combine your content. For example, _Go Tutorial_ or _.NET for beginners_.\n\nThis is done with a custom taxonomy - add `series` to the frontmatter on the content you'd like to group together.\n\n```toml\ntitle = \"How to use series\"\ndate = 2025-02-16\nseries = \"How to use structs in Go\"\ntags = [\"go\"]\n```\n\n### Details\n\nThere's a shortcode for encoding detail dropdowns into your pages.\n\n\n\u003cimg width=\"250\" alt=\"details-shortcode\" src=\"https://github.com/user-attachments/assets/75bc0cc1-4099-4113-aebb-1a0afd1bfcd2\" /\u003e\n\n\nHere's the code for the detail dropdown above:\n\n```\n{{\u003c details summary=\"Hidden content\" \u003e}}\nHello there\n{{\u003c /details \u003e}}\n```\n\n## How to Configure\n\n### The sidebar menu\n\nAny items you want displayed in your sidebar menu _must_ satisfy two requirements. They must:\n\n1. Have a corresponding markdown file in your _/content/_ directory.\n2. Be declared in your _hugo.toml_ file (example below).\n\nThere are two types of menu items:\n\n1. **Single Page** -- The _About_ menu item (to the left) is a good example of this. It displays a direct link to an individual page. For arbitrary single pages, the page content must be located at `content/\u003cfoo\u003e/_index.md` and the front matter of `_index.md` must contain `layout: single`.\n2. **List** -- The _Posts_ menu item is a good example of this. It displays a directory and dynamically lists the contents (i.e. pages) contained by date. List items have two optional configurations: a subheading (like the _Recent_ subheading that appears on the menu to the left), and a maximum number of items to display.\n\nThe sidebar menu items are configured with a dictionary value in your _hugo.toml_ file. I've included an example below. Additionally, there is a placeholder for this in the _hugo.toml_ file shown in the next section.\n\n**Important**: You _must_ have a markdown file present at the path specified in order for your menu item to be displayed.\n\n```toml\nmenu = [\n        # Dict keys:\n            # Name:         The name to display on the menu.\n            # URL:          The directory relative to the content directory.\n            # HasChildren:  If the directory's files should be listed.  Default is true.\n            # Limit:        If the files should be listed, how many should be shown.\n\n        # SINGLE PAGE\n        # Note that you must put your markdown file\n        # inside of a directory with the same name.\n\n        # Example:\n        # ... /content/about/about.md\n        {Name = \"About\", URL = \"/about/\", HasChildren = false},\n\n        # ... /content/foo/_index.md\n        # {Name = \"Foo\", URL = \"/foo/\", HasChildren = false},\n\n        # LIST\n        # This example has a subheading of \"Recent\"\n        # and will display up to 5 items.\n\n        # Example:\n        # ... /content/posts/introducing-rusty-poison.md\n        {Name = \"Posts\", URL = \"/posts/\", Pre = \"Recent\", HasChildren = true, Limit = 5},\n\n        # Example of a list without a subheading or limit.\n        {Name = \"Projects\", URL = \"/projects/\"},\n    ]\n```\n\n### The front page\n\nWhen visiting the base url for the site, i.e. `your.domain.com/`, a paginated feed of your recently added content is displayed in reverse chronological order. By default, only content in the \"posts\" [page bundle](https://gohugo.io/content-management/page-bundles/) is displayed. You can configure a list of page bundle names to be included on this page by adding the `front_page_content` parameter to your hugo.toml file.\n\n```toml\n[params]\n  front_page_content = [\"posts\", \"projects\"]\n```\n\n### Example config\n\nI recommend starting by copying/pasting the following code into your hugo.toml file. Once you see how it looks, play with the settings as needed.\n\n**NOTE**: To display an image in your sidebar, you'll need to uncomment the `remote_brand_image` and set a image URL or the `brand_image` path below and have it point to an image file in your project. The path is relative to the `static` directory. If you don't have an image, just leave both lines commented out.\n\n```toml\nbaseURL = \"https://example.com\"\nlanguageCode = \"en-us\"\ntheme = \"rusty-poison\"\npagination.pagerSize = 10\npluralizelisttitles = false\n\n[params]\n    brand = \"Rusty Poison\" # name of your site\n    # remote_brand_image = 'https://github.com/USERNAME.png' # path to a remote file\n    # brand_image = \"/images/_logo_.jpg\"    # path to the image shown in the sidebar\n    description = \"...\" # used as default meta description if not specified in front matter\n    dark_mode = true                      # optional - defaults to false\n    showDarkLight = true                  # optional - defaults to true\n    # favicon = \"favicon.png\"             # path to favicon\n    hideToc = false                       # optional\n\n    front_page_content = [\"posts\"] # Equivalent to the default value, add page bundle names to include them on the front page.\n\n    # MENU PLACEHOLDER\n    # Menu dict keys:\n        # Name:         The name to display on the menu.\n        # URL:          The directory relative to the content directory.\n        # HasChildren:  If the directory's files should be listed.  Default is true.\n        # Limit:        If the files should be listed, how many should be shown.\n    menu = [\n        # {Name = \"About\", URL = \"/about/\", HasChildren = false},\n        {Name = \"all posts\", URL = \"/posts/\", Pre = \"recent:\", HasChildren = true, Limit = 5},\n        {Name = \"tags\", URL = \"/tags/\", HasChildren = true},\n    ]\n\n    # Links to your socials. Comment or delete any you don't need \n    discord_url = \"https://discord.com\"\n    github_url = \"https://github.com\"\n    mastodon_url = \"https://mastodon.social\"\n    x_url = \"https://x.com\"\n    youtube_url = \"https://youtube.com\"\n    bluesky_url = \"https://bsky.app\"  \n\n    # NOTE: If you don't want to use RSS, comment or delete the following lines\n    # Adds an RSS icon to the end of the socials which links to {{ .Site.BaseURL }}/index.xml\n    rss_icon = true\n    # Which section the RSS icon links to, defaults to all content\n    rss_section = \"posts\"\n\n    # Uncomment and configure to enable umami analytics\n    # umami = true\n    # umami_script = \"https://cloud.umami.is/script.js\"\n    # umami_website_id = \"website_id\"\n\n    # Uncomment and configure to enable plausible analytics\n    # plausible = true\n    # plausible_domain = \"myblog.com\"\n    # plausible_script = \"https://plausible.myblog.com/js/script.js\"\n\n    # Hex colors for sidebar\n    moon_sun_background_color = \"#121212\"   # default is #121212\n    moon_sun_color = \"#FAF9F6\"              # default is #FAF9F6\n    sidebar_a_color = \"#FFF\"                # default is #FFF\n    sidebar_bg_color = \"#191919\"            # default is #191919\n    sidebar_h1_color = \"#FFF\"               # default is #FFF\n    sidebar_img_border_color = \"#313131\"    # default is #313131\n    sidebar_p_color = \"#909090\"             # default is #909090\n    sidebar_socials_color = \"#FFF\"          # default is #FFF\n\n    # Hex colors for light mode\n    code_color = \"#000\"                     # default is #000\n    code_background_color = \"#E5E5E5\"       # default is #E5E5E5\n    code_block_color = \"#FFF\"               # default is #FFF\n    code_block_background_color = \"#272822\" # default is #272822\n    content_bg_color = \"#FAF9F6\"            # default is #FAF9F6\n    date_color = \"#515151\"                  # default is #515151\n    link_color = \"#3674B5\"                  # default is #3674B5\n    list_color = \"#5A5A5A\"                  # default is #5A5A5A\n    post_title_color = \"#303030\"            # default is #303030\n    table_border_color = \"#E5E5E5\"          # default is #E5E5E5\n    table_stripe_color = \"#F9F9F9\"          # default is #F9F9F9\n    text_color = \"#222\"                     # default is #222\n\n    # Hex colors for dark mode\n    code_color_dark = \"#FFF\"                        # default is #FFF\n    code_background_color_dark = \"#515151\"          # default is #515151\n    code_block_color_dark = \"#FFF\"                  # default is #FFF\n    code_block_background_color_dark = \"#272822\"    # default is #272822\n    content_bg_color_dark = \"#121212\"               # default is #121212\n    date_color_dark = \"#9A9A9A\"                     # default is #9A9A9A\n    link_color_dark = \"#578FCA\"                     # default is #578FCA\n    list_color_dark = \"#9D9D9D\"                     # default is #9D9D9D\n    post_title_color_dark = \"#DBE2E9\"               # default is #DBE2E9\n    table_border_color_dark = \"#515151\"             # default is #515151\n    table_stripe_color_dark = \"#202020\"             # default is #202020\n    text_color_dark = \"#EEE\"                        # default is #EEE\n\n    # NOTE: The following three params are optional and are used to create meta tags + enhance SEO.\n    # og_image = \"\"                       # path to social icon - front matter: image takes precedent, then og_image, then brand_url\n                                          # this is also used in the schema output as well. Image is resized to max 1200x630\n                                          # For this to work though og_image and brand_url must be a path inside the assets directory\n                                          # e.g. /assets/images/site/og-image.png becomes images/site/og-image.png\n    # publisher_icon = \"\"                 # path to publisher icon - defaults to favicon, used in schema\n\n[taxonomies]\n    series = 'series'\n    tags = 'tags'\n```\n\n### Custom CSS\n\nYou can override any setting in theme's static CSS files by adding your own\n`/assets/css/custom.css` file. For example, if you want to override the title font and\nfont size, you could add this:\n\n```css\n.sidebar-about h1 {\n\tfont-size: 1.4em;\n\tfont-family: 'Terminess Nerd', monospace;\n}\n```\n\n## License\n\nThis theme is licensed under [GNU General Public License v3.0](LICENSE.md).\n\n---\nIf you want to see the changes made to the original theme, [read it here](diff.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frustydaemon%2Frusty-poison","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frustydaemon%2Frusty-poison","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frustydaemon%2Frusty-poison/lists"}