{"id":15287925,"url":"https://github.com/onweru/hugo-swift-theme","last_synced_at":"2025-09-09T08:37:58.914Z","repository":{"id":53910847,"uuid":"170762804","full_name":"onweru/hugo-swift-theme","owner":"onweru","description":"A simple open source theme for publishing with hugo","archived":false,"fork":false,"pushed_at":"2025-02-02T15:23:13.000Z","size":3724,"stargazers_count":119,"open_issues_count":2,"forks_count":65,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-05-24T07:04:03.550Z","etag":null,"topics":["deeplinks","gallery","hugo","hugo-theme","lazy-loading","sass","staticman"],"latest_commit_sha":null,"homepage":"https://makefun.space","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/onweru.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2019-02-14T21:49:30.000Z","updated_at":"2025-02-02T15:23:17.000Z","dependencies_parsed_at":"2023-11-07T16:35:03.798Z","dependency_job_id":"c6fd4935-1f89-4456-9423-177812c0d060","html_url":"https://github.com/onweru/hugo-swift-theme","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/onweru/hugo-swift-theme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onweru%2Fhugo-swift-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onweru%2Fhugo-swift-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onweru%2Fhugo-swift-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onweru%2Fhugo-swift-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/onweru","download_url":"https://codeload.github.com/onweru/hugo-swift-theme/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onweru%2Fhugo-swift-theme/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274268367,"owners_count":25253386,"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","status":"online","status_checked_at":"2025-09-09T02:00:10.223Z","response_time":80,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["deeplinks","gallery","hugo","hugo-theme","lazy-loading","sass","staticman"],"created_at":"2024-09-30T15:39:36.195Z","updated_at":"2025-09-09T08:37:58.883Z","avatar_url":"https://github.com/onweru.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Swift Theme\n\nThis theme is designed for blogging purposes. Feel free to extend it for other\nuse cases though.\n\nAt its core, it's minimalistic; it doesn't rely on monolithic libraries such e.g\njquery, bootstrap. Instead, it uses *grid css*, *flexbox* \u0026 *vanilla js* to\nfacilitate the `features` outlined below:\n\n![Hugo Swift Theme](https://github.com/onweru/hugo-swift-theme/blob/master/images/screenshot.png)\n\n## Features\n\n* Blog\n* Pagination\n* Deeplinks\n* Dark Mode\n* Syntax Highlighting\n* Gallery Support\n* Native lazy loading of images\n* [Staticman](#staticman-comments)\n  * [reCAPTCHA](https://developers.google.com/recaptcha/docs/display)\n\n## Prerequisites\n\nThis theme uses `sass`. Ensure you have the [extended version of hugo](https://github.com/gohugoio/hugo/releases) installed or in your pipeline.\n\n## Installation\n\nAdd this theme as a Git submodule inside your Hugo site folder:\n\n```bash\ngit submodule add https://github.com/onweru/hugo-swift-theme.git themes/hugo-swift-theme\n```\n\n## Configuration\n\nYou can configure the site using as follows:\n\n1. ### Global Settings \u0026 Staticman\n\n    Use the file `hugo.toml`.\n2. ### menu, footer\n\n    See the **hugo.toml** file's menu areas.\n\n    \u003e Follow the `exampleSite/`.\n3. Customize Theme colors\n    You can do so easily in the [variables sass partial](https://github.com/onweru/hugo-swift-theme/blob/e5af8a1414cd8e1ec5a0817f8e5eb8c8c98e2676/assets/sass/_variables.sass#L13-L21). Use names (e.g red, blue, darkgoldenrod), rgb, rgba, hsla or hex values.\n\n## Staticman Comments\n\nBy default, [Staticman](https://staticman.net) comments are disabled.\nTo enable them, you may refer to the\n[Staticman config Wiki](https://github.com/onweru/hugo-swift-theme/wiki/staticman-config).\n\n## Written By Block\n\n### How do I include a `written by` ?\n\n  1. Copy [this authors yaml file](https://github.com/onweru/hugo-swift-theme/blob/master/exampleSite/data/authors.yml) from the `exampleSite` into your sites `./data` directory.\n\n  ```toml\n    [[params.authors]]\n      name = \"yourName\" # if fullName 👇🏻 isn't set, name will be displayed on author card\n      fullName = \"Your Full Name\" # optional. If set, it will display on author card\n      bio = \"It's time to flex. Write a short or not-so-short summary about yourself.\"\n      photo = \"myPhotoFile.jpg\"\n      url = \"https://myURLofChoice.domain\"\n  ```\n\n  2. Specify the name in your content files\n\n  ```yaml\n  ...\n  author: \"yourName\" # case sensitive. must match the name value in your saved data \n  ...\n  ```\n### What if I want to exclude the `written by` from some articles?\n\nDon't include an `author` in your article front matter.\n\nThe `[[.Params.authors]]` interface in the hugo.toml file helps you:\n\n  1. Write all your author information in one place. This way, you only specify the author name on your content files (posts). The rest of the data i.e photo, url \u0026 bio are automatically pulled from the data file.\n\n  2. In certain situations, you may have different people publishing articles on your blog. For example, you could have someone guest blog. Or may be you have a blog co-author.\n\n\n## Deeplinks\n\nFor all content published using markdown, deeplinks will be added to the pages\nso that you can share with precision :smiley: Just   hover on a heading and the\nlink button will pop. Click it to copy.\n\n## Dark Mode\n\nToday most operating systems \u0026 browsers support dark mode. Like twitter, which\nautomatically turns into dark mode when the user chooses darkmode, this theme\ndoes the same thing.\n\n![Dark Mode](https://github.com/onweru/hugo-swift-theme/blob/master/images/darkmode.jpg)\n\n## Custom Shortcodes\n\nThis theme ships with two custom shortcodes (they both use positional parameters):\n\n1. __Video__\n    This shortcode can be used to embed a youtube video with custom styling. It takes a solo positional parameter.\n\n    ```\n    ...\n    {{\u003c video \"youtubeVideoID\" \u003e}}\n    ...\n    ```\n\n2. __Picture__\n    You want to use darkmode images when darkmode is enabled on a device and a regular image on lightmode? It takes 3 positional parameters\n\n    Store these images in the `static/images` directory.\n\n    ```\n    ...\n    {{\u003c picture \"lightModeImage.png\" \"darkModeImage.png\" \"Image alt text\" \u003e}}\n    ...\n    ```\n\n3. __Gallery__\n    Include inline galleries within your articles. These galleries can contain `N` number of images. It takes 2 positional parameters.\n\n    The 1st parameter is required. It's a _comma-separated list_ (`,`) of your images' paths.\n\n    The 2nd parameter is optional. It's a _double-collon-separated list_ (`::`) of your images' alt/description/captions text. It's always a good SEO practice to include alt text for your images.\n\n    ```\n    ...\n    {{\u003c gallery \"image1Path.png,image3Path.webp,image4Path.jpg\" \"A PNG gallery image::A WEBP gallery image::A JPEG gallery image\" \u003e}}\n    ...\n    ```\n\n    \u003e For legibility, you can include a space after the delimiters `,` \u0026 `::`\n\n## License\n\nThe code is available under the\n[MIT license](https://github.com/onweru/hugo-swift-theme/blob/master/LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonweru%2Fhugo-swift-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fonweru%2Fhugo-swift-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonweru%2Fhugo-swift-theme/lists"}