Skip to content

CodeGateCircle/ui-codegate

Repository files navigation

Antora Default UI

This project is an archetype that demonstrates how to produce a UI bundle that can be used by Antora to generated a documentation site. You can see a preview of the default UI at codegatecircle.github.io/ui-codegate.

While the default UI is ready to be used with Antora, the intent is that you’ll fork it and customize it for your own needs. It’s intentionally minimalistic so as to give you a good starting point without requiring too much effort to customize.

Command List

╰─➤  gulp --tasks
[18:51:10] Build tasks for the Antora default UI project
[18:51:10] ├── default        => bundle
[18:51:10] ├── clean          Clean files and folders generated by build
[18:51:10] ├── format         Format the JavaScript source files using prettify (JavaScript Standard Style)
[18:51:10] ├── build          Build and stage the UI assets for bundling
[18:51:10] ├── bundle         Clean, lint, build, and bundle the UI for publishing
[18:51:10] ├── preview        Generate a preview site and launch a server to view it
[18:51:10] ├── preview:build  Process and stage the UI assets and generate pages for the preview
[18:51:10] └── bundle:pack    Create a bundle of the staged UI assets for publishing

Copyright © 2025 Codegate Circle.

Use of this software is granted under the terms of the Mozilla Public License Version 2.0 (MPL-2.0). See LICENSE to find the full license text.

Authors

Codegate Circle.

caution

  • install cssnano and gulp-cssnano

About

about antora custom ui

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors