{"id":21559576,"url":"https://github.com/harrymkt/hguinav","last_synced_at":"2025-07-29T04:02:44.978Z","repository":{"id":262574882,"uuid":"887679718","full_name":"harrymkt/hguinav","owner":"harrymkt","description":"A multilingual Hugo theme designed for accessibility","archived":false,"fork":false,"pushed_at":"2025-06-12T11:03:23.000Z","size":1174,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-12T12:20:43.178Z","etag":null,"topics":["accessible","blind","blog","documentation","hugo","multilingual","static","theme"],"latest_commit_sha":null,"homepage":"https://harrymkt.github.io/hguinav/","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/harrymkt.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,"zenodo":null}},"created_at":"2024-11-13T05:07:46.000Z","updated_at":"2025-06-12T11:03:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"f04437bd-bb24-4abe-92bf-e8d4be363f2f","html_url":"https://github.com/harrymkt/hguinav","commit_stats":null,"previous_names":["harrymkt/hguinav"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/harrymkt/hguinav","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harrymkt%2Fhguinav","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harrymkt%2Fhguinav/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harrymkt%2Fhguinav/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harrymkt%2Fhguinav/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/harrymkt","download_url":"https://codeload.github.com/harrymkt/hguinav/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harrymkt%2Fhguinav/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267626482,"owners_count":24117699,"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-07-29T02:00:12.549Z","response_time":2574,"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":["accessible","blind","blog","documentation","hugo","multilingual","static","theme"],"created_at":"2024-11-24T09:07:45.838Z","updated_at":"2025-07-29T04:02:44.962Z","avatar_url":"https://github.com/harrymkt.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# UI Navigation\nUI Navigation, or known as hguinav, is a [Hugo](https://gohugo.io/) theme designed for accessibility rather than visual and made as easy as possible. Since I am a blind developer, I would like to develop with accessibility as possible so visually impaired users can use them.\n\nThis theme is also available for Zola at [Zluinav](https://github.com/harrymkt/zluinav).\n\nThis theme uses blocks as possible because as far as I know Hugo does not allow extend and super functions like other static site generators.\n\n[Theme demo](https://harrymkt.github.io/hguinav)\n\n## License\nThis theme is distributed under the terms of the [MIT License](https://github.com/harrymkt/hguinav/blob/main/LICENSE.md).\n\n## Features\n- Accessibility; Hguinav is designed to be accessible as possible, especially for blind and visually impaired. This is done by using accessibility tags, such as ARIA, and other possible accessibility features.\n- SEO friendly.\n- Multilingual support with i18n; Hugo supports built-in advance multilingual feature, this theme only adds templates for it.\n- Customizable extrahead, extrafooter, head, header, footer, with partials, and extrahead, with blocks.\n- Customizable Documentation Site; build accessible [documentation sites](https://harrymkt.github.io/hguinav/docs/documentation) by using built-in template specifically designed for documentation. You set the layout of the section you want to document as well as in each page of that related document.\n- [Content variables](https://harrymkt.github.io/hguinav/docs/writing) during build, such as `%title%`.\n- Sort pages by the way you like and for specific sections, which is by default not supported. This uses the [sort](https://harrymkt.github.io/hguinav/docs/partials/sort) partial.\n- Define per-section pagination size.\n- Define menu pages that check for multilingual with the special [menu](https://harrymkt.github.io/hguinav/docs/partials/menu) partial.\n- Built-in blog post templates.\n- Copy code blocks; add code blocks which can then be copied using buttons and display the code language if available, helped by JavaScript.\n- Local date display; display dates in user's local timezone, no matter what timezone the date is set.\n- Taxonomies support.\n- Taxonomy based [author/user management](https://harrymkt.github.io/hguinav/docs/author-taxonomy), provided in demo.\n- Built-in [search](https://harrymkt.github.io/hguinav/docs/search) support, with a variety of search formats.\n- Use [blocks](https://harrymkt.github.io/hguinav/docs/blocks) to easily modify without having to copy some files to your layouts.\n- Use a large number of partials and shortcodes to make your content and/or templates shorten.\n- Ability to toggle the use of JavaScript for both config and per-page frontmadder.\n- Comprehensive documentation; Hguinav provides a full Comprehensive documentation including possible layouts, partials, shortcodes, blocks, configurable parameters, and more, everything as it updates.\n\n## Installation\nUsing git clone method:\n```bash\ncd themes\ngit clone https://github.com/harrymkt/hguinav.git\n```\nOr [download manually](https://github.com/harrymkt/hguinav/archive/refs/heads/main.zip) and paste in the themes directory.\n\nOr, add to the Git submodule (recommended):\n```bash\ngit submodule add --name hguinav https://github.com/harrymkt/hguinav.git themes/hguinav\ngit submodule update --remote\n```\n\nNext, set the theme in your config.\n`theme = \"hguinav\"`\n\n## Configuration\nPlease read the [documentation](https://harrymkt.github.io/hguinav) for more information and configuration options.\n\n## Contribution\nContributions to this theme are welcome, provided that the following requirements are met:\n- Use 2 level space indentation for HTML. Use 1 tab level indentation for CSS, TOML and JavaScript. If Markdown files need indentation, use 1 tab.\n- Be the templates accessible for visually impaired and/or blind and prefer readability. Don't worry, I will process in case accessibility issues before pull requests are merged.\n- Photos are not required in this theme. You may design with CSS for visual if you so wish.\n- When creating a pull request it is advised that you:\n\t- Use different branch other than main; this avoids issues with updating in case your pull request gets rejected.\n\nThank you!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharrymkt%2Fhguinav","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fharrymkt%2Fhguinav","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharrymkt%2Fhguinav/lists"}