https://github.com/redis/antora-ui-redis
Antora UI bundle for Redis projects
https://github.com/redis/antora-ui-redis
Last synced: 25 days ago
JSON representation
Antora UI bundle for Redis projects
- Host: GitHub
- URL: https://github.com/redis/antora-ui-redis
- Owner: redis
- License: mpl-2.0
- Created: 2025-09-27T22:22:08.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-09-29T17:32:15.000Z (8 months ago)
- Last Synced: 2026-02-07T17:50:23.681Z (4 months ago)
- Language: CSS
- Size: 1.51 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/spring-io/antora-ui-spring/actions/workflows/push.yml)
This project generates and packages the static resources that Spring uses for document production.
This project is based on [Antora](https://antora.org).
## Development Quickstart
This section offers a basic tutorial to teach you how to preview it locally, and bundle it for use with Antora.
A more comprehensive tutorial can be found in the documentation at [docs.antora.org](https://docs.antora.org/).
### Prerequisites
To preview and bundle the Antora Spring UI, you need the following software on your computer:
* [git](https://git-scm.com/) (command: `git`)
* [Node.js](https://nodejs.org/) (commands: `node` and `npm`)
* [Gulp CLI](http://gulpjs.com/) (command: `gulp`)
### Preview the UI
The Spring Antora UI project is configured to preview offline.
The files in the `preview-src/` folder provide the sample content that allow you to see the UI in action.
In this folder, you'll primarily find pages written in AsciiDoc.
These pages provide a representative sample and kitchen sink of content from the real site.
To build the UI and preview it in a local web server, run the `preview` command:
```
npm install
gulp preview
```
You'll see a URL listed in the output of this command:
```
[12:00:00] Starting server...
[12:00:00] Server started http://localhost:5252
[12:00:00] Running server
```
Navigate to this URL to preview the site locally.
While this command is running, any changes you make to the source files will be instantly reflected in the browser.
This works by monitoring the project for changes, running the `preview:build` task if a change is detected, and sending the updates to the browser.
Press `Ctrl`+`C` to stop the preview server and end the continuous build.
### Package for Use with Antora
If you need to package the UI so you can use it to generate the documentation site locally, run the following command:
```
gulp bundle
```
If any errors are reported by lint, you'll need to fix them.
When the command completes successfully, the UI bundle will be available at `build/ui-bundle.zip`.
You can point Antora at this bundle using the `--ui-bundle-url` command-line option.
If you have the preview running, and you want to bundle without causing the preview to be clobbered, use:
```
gulp bundle:pack
```
The UI bundle will again be available at `build/ui-bundle.zip`.
## Extensions to the UI
### Favicon
The 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.
```
site:
keys:
favicon: /img/korvet-favicon.png
faviconType: image/png
```
### Related Documentation
The UI presents a list of related documentation and that documentation can be filtered using two attributes:
* page-related-doc-categories - The categories to be included in the related documentation
* page-related-doc-projects - The project ids to be included in the related documentation
For 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)
The configuration is typically specified in asciidoc attributes section of the `antora-playbook.yml`:
```
asciidoc:
attributes:
# Include the projects with the security category
page-related-doc-categories: security
# Include the projects with ids framework and graphql
page-related-doc-projects: framework,graphql
```
The Related Documentation links to the `All Docs...` page.
To 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.
## Authors
Development of Antora is led and sponsored by [OpenDevise Inc](https://opendevise.com/).
## Copyright and License
Copyright (C) 2017-present OpenDevise Inc. and the Antora Project.
Use 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).
See [LICENSE](https://github.com/spring-io/antora-ui-spring/blob/feat/gh-226/LICENSE) to find the full license text.