{"id":32071461,"url":"https://github.com/redis/antora-ui-redis","last_synced_at":"2026-05-14T20:05:41.765Z","repository":{"id":318707860,"uuid":"1065520669","full_name":"redis/antora-ui-redis","owner":"redis","description":"Antora UI bundle for Redis projects","archived":false,"fork":false,"pushed_at":"2025-09-29T17:32:15.000Z","size":1583,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-07T17:50:23.681Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/redis.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-27T22:22:08.000Z","updated_at":"2025-09-29T17:31:43.000Z","dependencies_parsed_at":"2025-10-10T00:20:37.923Z","dependency_job_id":"50ac5bf8-9b15-4276-80b3-7fc671e596e0","html_url":"https://github.com/redis/antora-ui-redis","commit_stats":null,"previous_names":["redis/antora-ui-redis"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/redis/antora-ui-redis","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redis%2Fantora-ui-redis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redis%2Fantora-ui-redis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redis%2Fantora-ui-redis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redis%2Fantora-ui-redis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/redis","download_url":"https://codeload.github.com/redis/antora-ui-redis/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redis%2Fantora-ui-redis/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33041239,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-13T13:14:54.681Z","status":"online","status_checked_at":"2026-05-14T02:00:06.663Z","response_time":57,"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":[],"created_at":"2025-10-19T05:33:08.753Z","updated_at":"2026-05-14T20:05:41.760Z","avatar_url":"https://github.com/redis.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.spring.io/\"\u003e\n    \u003cimg alt=\"Spring\" src=\"https://spring.io/img/spring-2.svg\" width=\"250\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n[![On Push](https://github.com/spring-io/antora-ui-spring/actions/workflows/push.yml/badge.svg?branch=main)](https://github.com/spring-io/antora-ui-spring/actions/workflows/push.yml)\n\n\nThis project generates and packages the static resources that Spring uses for document production.\n\nThis project is based on [Antora](https://antora.org).\n\n\n## Development Quickstart\n\nThis section offers a basic tutorial to teach you how to preview it locally, and bundle it for use with Antora.\nA more comprehensive tutorial can be found in the documentation at [docs.antora.org](https://docs.antora.org/).\n\n### Prerequisites\n\nTo preview and bundle the Antora Spring UI, you need the following software on your computer:\n\n* [git](https://git-scm.com/) (command: `git`)\n* [Node.js](https://nodejs.org/) (commands: `node` and `npm`)\n* [Gulp CLI](http://gulpjs.com/) (command: `gulp`)\n\n### Preview the UI\n\nThe Spring Antora UI project is configured to preview offline.\nThe files in the `preview-src/` folder provide the sample content that allow you to see the UI in action.\nIn this folder, you'll primarily find pages written in AsciiDoc.\nThese pages provide a representative sample and kitchen sink of content from the real site.\n\nTo build the UI and preview it in a local web server, run the `preview` command:\n\n```\nnpm install\ngulp preview\n```\n\nYou'll see a URL listed in the output of this command:\n\n```\n[12:00:00] Starting server...\n[12:00:00] Server started http://localhost:5252\n[12:00:00] Running server\n```\n\nNavigate to this URL to preview the site locally.\n\nWhile this command is running, any changes you make to the source files will be instantly reflected in the browser.\nThis works by monitoring the project for changes, running the `preview:build` task if a change is detected, and sending the updates to the browser.\n\nPress `Ctrl`+`C` to stop the preview server and end the continuous build.\n\n### Package for Use with Antora\n\nIf you need to package the UI so you can use it to generate the documentation site locally, run the following command:\n\n```\ngulp bundle\n```\n\nIf any errors are reported by lint, you'll need to fix them.\n\nWhen the command completes successfully, the UI bundle will be available at `build/ui-bundle.zip`.\nYou can point Antora at this bundle using the `--ui-bundle-url` command-line option.\n\nIf you have the preview running, and you want to bundle without causing the preview to be clobbered, use:\n\n```\ngulp bundle:pack\n```\n\nThe UI bundle will again be available at `build/ui-bundle.zip`.\n\n## Extensions to the UI\n\n### Favicon\n\nThe UI uses `img/favicon.ico` by default. To override it for a specific docs site, set `site.keys.favicon` in the Antora playbook to the icon URL you want rendered in the page head. You can optionally set `site.keys.faviconType` to control the MIME type.\n\n```\nsite:\n  keys:\n    favicon: /img/korvet-favicon.png\n    faviconType: image/png\n```\n\n### Related Documentation\n\nThe UI presents a list of related documentation and that documentation can be filtered using two attributes:\n\n* page-related-doc-categories - The categories to be included in the related documentation\n* page-related-doc-projects - The project ids to be included in the related documentation\n\nFor a complete listing of valid categories and ids view [related_projects.js](https://github.com/spring-io/antora-ui-spring/blob/main/src/helpers/related_projects.js)\n\nThe configuration is typically specified in asciidoc attributes section of the `antora-playbook.yml`:\n\n```\nasciidoc:\n  attributes:\n    # Include the projects with the security category\n    page-related-doc-categories: security\n    # Include the projects with ids framework and graphql\n    page-related-doc-projects: framework,graphql\n```\n\nThe Related Documentation links to the `All Docs...` page.\nTo include this resource, ensure that the [antora-extensions](https://github.com/spring-io/antora-extensions/blob/main/README.adoc) is using 1.7.0+ and the [Static Page Extension](https://github.com/spring-io/antora-extensions/blob/main/README.adoc#static-page) is included.\n\n## Authors\n\nDevelopment of Antora is led and sponsored by [OpenDevise Inc](https://opendevise.com/).\n\n## Copyright and License\n\nCopyright (C) 2017-present OpenDevise Inc. and the Antora Project.\n\nUse of this software is granted under the terms of the [Mozilla Public License Version 2.0](https://www.mozilla.org/en-US/MPL/2.0/) (MPL-2.0).\nSee [LICENSE](https://github.com/spring-io/antora-ui-spring/blob/feat/gh-226/LICENSE) to find the full license text.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredis%2Fantora-ui-redis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fredis%2Fantora-ui-redis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredis%2Fantora-ui-redis/lists"}