Skip to content
This repository was archived by the owner on Jul 15, 2026. It is now read-only.

Commit e79e7e7

Browse files
author
Felix Hennig
committed
Added more info
1 parent 9cbbd9b commit e79e7e7

1 file changed

Lines changed: 39 additions & 170 deletions

File tree

‎README.adoc‎

Lines changed: 39 additions & 170 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
:experimental:
44
:hide-uri-scheme:
55
// Project URLs:
6-
:url-project: https://gitlab.com/antora/antora-ui-default
6+
:url-default-ui: https://gitlab.com/antora/antora-ui-default
77
// External URLs:
88
:url-stackable-docs: https://docs.stackable.tech/
99
:url-antora-docs: https://docs.antora.org
@@ -16,201 +16,70 @@
1616
:url-nvm-install: {url-nvm}#installation
1717
:url-source-maps: https://developer.mozilla.org/en-US/docs/Tools/Debugger/How_to/Use_a_source_map
1818

19-
This project is the UI template used on {url-stackable-docs}[the Stackable docs]. It is based on the Antora default UI. As intended, this repository is forked from the default UI and customized to our needs.
19+
This project is the UI template used on {url-stackable-docs}[the Stackable docs]. It is based on the {url-default-ui}[Antora default UI]. As intended, this repository is forked from the default UI and customized to our needs. The document below contains information about this repo, but consult the default UI README as well for additional useful information.
2020

21-
== Notes on our Customized Version
22-
23-
=== Tracking
24-
We have added our own tracking solution into `src/partials/head-scripts.hbs`. It has the URL hardcoded. it can be enabled by setting `site.keys.enable_tracking` to `true`/`false` in the Antora playbook.
25-
26-
=== Highlight.js v10
27-
[Ticket](https://github.com/stackabletech/documentation/issues/232) - Due to the removal of HTML-passthru in v11 (which we need for [Callouts](https://docs.asciidoctor.org/asciidoc/latest/verbatim/callouts/)) the highlight.js has not been updated from v10. This also affects the Antora Default UI. Both decisions will be revisited when the upstream upgrade is available.
28-
29-
=== Gulp
30-
31-
To work on the build process of this, you need to understand [gulp](https://gulpjs.com/docs/en/getting-started/javascript-and-gulpfiles). Gulp is a builder/bundler that is used to package this antora UI.
32-
33-
In this project, `gulpfile.js` is the main entrypoint for gulp. This file references tasks in the `gulp.d` directory.
34-
35-
== Code of Conduct
36-
37-
The Antora project and its project spaces are governed by our https://gitlab.com/antora/antora/-/blob/HEAD/CODE-OF-CONDUCT.adoc[Code of Conduct].
38-
By participating, you're agreeing to honor this code.
39-
Let's work together to make this a welcoming, professional, inclusive, and safe environment for everyone.
40-
41-
== Use the Default UI
42-
43-
If you want to simply use the default UI for your Antora-generated site, add the following UI configuration to your playbook:
44-
45-
[source,yaml]
46-
----
47-
ui:
48-
bundle:
49-
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
50-
snapshot: true
51-
----
52-
53-
NOTE: The `snapshot` flag tells Antora to fetch the UI when the `--fetch` command-line flag is present.
54-
This setting is required because updates to the UI bundle are pushed to the same URL.
55-
If the URL were to be unique, this setting would not be required.
56-
57-
Read on to learn how to customize the default UI for your own documentation.
58-
59-
== Development Quickstart
60-
61-
This section offers a basic tutorial to teach you how to set up the default UI project, preview it locally, and bundle it for use with Antora.
62-
A more comprehensive tutorial can be found in the documentation at {url-antora-docs}.
63-
64-
=== Prerequisites
65-
66-
To preview and bundle the default UI, you need the following software on your computer:
67-
68-
* {url-git}[git] (command: `git`)
69-
* {url-nodejs}[Node.js] (commands: `node` and `npm`)
70-
* {url-gulp}[Gulp CLI] (command: `gulp`)
71-
72-
==== git
73-
74-
First, make sure you have git installed.
75-
76-
$ git --version
77-
78-
If not, {url-git-dl}[download and install] the git package for your system.
79-
80-
==== Node.js
81-
82-
Next, make sure that you have Node.js installed (which also provides npm).
83-
84-
$ node --version
85-
86-
If this command fails with an error, you don't have Node.js installed.
87-
If the command doesn't report an LTS version of Node.js (e.g., v10.15.3), it means you don't have a suitable version of Node.js installed.
88-
In this guide, we'll be installing Node.js 10.
89-
90-
While you can install Node.js from the official packages, we strongly recommend that you use {url-nvm}[nvm] (Node Version Manager) to manage your Node.js installation(s).
91-
Follow the {url-nvm-install}[nvm installation instructions] to set up nvm on your machine.
21+
== Quickstart
9222

93-
Once you've installed nvm, open a new terminal and install Node.js 10 using the following command:
23+
`npm` is required. We recommend `nvm` to install `npm`, see the Default UI README for instructions on how to install it.
9424

95-
$ nvm install 10
25+
Run
9626

97-
You can switch to this version of Node.js at any time using the following command:
27+
[source,js]
28+
npm ci
29+
npm run bundle
9830

99-
$ nvm use 10
31+
to create a bundle. It will be created in `build/ui-bundle.zip`
10032

101-
To make Node.js 10 the default in new terminals, type:
33+
== Project structure
10234

103-
$ nvm alias default 10
35+
The UI bundle is basically a collection of handlebars templates and some minimal JS and CSS, which is then filled with life with the documentation content. All of this lives in the `src` directory.
10436

105-
Now that you have Node.js installed, you can proceed with installing the Gulp CLI.
37+
Inside the `src` directory are:
10638

107-
==== Gulp CLI
39+
* `css`: Contains all the CSS. `site.css` contains imports of all the other files. In `vendor` there is the copied-in FontAwesome CSS file.
40+
* `helpers`: Contains Handlebars helper functions. The file names are the names of the helpers. You can use these inside the Handlebars templates.
41+
* `img`: Images used in the UI.
42+
* `js`: TODO
43+
* `layouts`: TODO
44+
* `partials`: Contains all the Handlebars files. This is the directory containing all the templated HTML for the site.
10845

109-
You'll need the Gulp command-line interface (CLI) to run the build.
110-
The Gulp CLI package provides the `gulp` command which, in turn, executes the version of Gulp declared by the project.
46+
== Build process
11147

112-
You can install the Gulp CLI globally (which resolves to a location in your user directory if you're using nvm) using the following command:
48+
The UI is built with Gulp. Linting, bundling and previewing is supported. This repository is referenced as a submodule in the documentation repository and the bundling takes place there.
11349

114-
$ npm install -g gulp-cli
115-
116-
Verify the Gulp CLI is installed and on your PATH by running:
117-
118-
$ gulp --version
119-
120-
If you prefer to install global packages using Yarn, run this command instead:
121-
122-
$ yarn global add gulp-cli
123-
124-
Alternately, you can use the `gulp` command that is installed by the project's dependencies.
125-
126-
$ $(npm bin)/gulp --version
127-
128-
Now that you have the prerequisites installed, you can fetch and build the UI project.
129-
130-
=== Clone and Initialize the UI Project
131-
132-
Clone the default UI project using git:
133-
134-
[subs=attributes+]
135-
$ git clone {url-project} &&
136-
cd "`basename $_`"
137-
138-
The example above clones Antora's default UI project and then switches to the project folder on your filesystem.
139-
Stay in this project folder when executing all subsequent commands.
140-
141-
Use npm to install the project's dependencies inside the project.
142-
In your terminal, execute the following command:
143-
144-
$ npm install
145-
146-
This command installs the dependencies listed in [.path]_package.json_ into the [.path]_node_modules/_ folder inside the project.
147-
This folder does not get included in the UI bundle and should _not_ be committed to the source control repository.
148-
149-
[TIP]
150-
====
151-
If you prefer to install packages using Yarn, run this command instead:
152-
153-
$ yarn
154-
====
155-
156-
=== Preview the UI
50+
=== Gulp
15751

158-
The default UI project is configured to preview offline.
159-
The files in the [.path]_preview-src/_ folder provide the sample content that allow you to see the UI in action.
160-
In this folder, you'll primarily find pages written in AsciiDoc.
161-
These pages provide a representative sample and kitchen sink of content from the real site.
52+
To work on the build process of this, you need to understand [gulp](https://gulpjs.com/docs/en/getting-started/javascript-and-gulpfiles). Gulp is a builder/bundler that is used to package this antora UI.
16253

163-
To build the UI and preview it in a local web server, run the `preview` command:
54+
In this project, `gulpfile.js` is the main entrypoint for gulp. This file references tasks in the `gulp.d` directory.
16455

165-
$ gulp preview
56+
You don't need to install the `gulp` CLI yourself, you can call package scripts (i.e. `npm run bundle` which will then call `gulp` from the `node_modules`)
16657

167-
You'll see a URL listed in the output of this command:
58+
=== Building the final documentation
16859

169-
....
170-
[12:00:00] Starting server...
171-
[12:00:00] Server started http://localhost:5252
172-
[12:00:00] Running server
173-
....
60+
The documentation repository uses this repository as a submodule, bundles the UI on demand and then links to it like this in the Playbook:
17461

175-
Navigate to this URL to preview the site locally.
62+
[source,yaml]
63+
ui:
64+
bundle:
65+
url: ./ui/build/ui-bundle.zip
17666

177-
While this command is running, any changes you make to the source files will be instantly reflected in the browser.
178-
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.
67+
=== Previewing the UI during development
17968

69+
It is useful to be able to see changes quickly while working on the UI. To start the preview at http://localhost:5252, run `npm run preview`.
18070
Press kbd:[Ctrl+C] to stop the preview server and end the continuous build.
18171

182-
=== Package for Use with Antora
183-
184-
If you need to package the UI so you can use it to generate the documentation site locally, run the following command:
185-
186-
$ gulp bundle
187-
188-
If any errors are reported by lint, you'll need to fix them.
189-
190-
When the command completes successfully, the UI bundle will be available at [.path]_build/ui-bundle.zip_.
191-
You can point Antora at this bundle using the `--ui-bundle-url` command-line option.
192-
193-
If you have the preview running, and you want to bundle without causing the preview to be clobbered, use:
72+
==== How it works
19473

195-
$ gulp bundle:pack
74+
The `preview-src` directory contains dummy docs content which will be used to render the UI templates. The `ui-model.yml` contains dummy information similar to the antora-playbook.yaml.
19675

197-
The UI bundle will again be available at [.path]_build/ui-bundle.zip_.
198-
199-
==== Source Maps
200-
201-
The build consolidates all the CSS and client-side JavaScript into combined files, [.path]_site.css_ and [.path]_site.js_, respectively, in order to reduce the size of the bundle.
202-
{url-source-maps}[Source maps] correlate these combined files with their original sources.
203-
204-
This "`source mapping`" is accomplished by generating additional map files that make this association.
205-
These map files sit adjacent to the combined files in the build folder.
206-
The mapping they provide allows the debugger to present the original source rather than the obfuscated file, an essential tool for debugging.
207-
208-
In preview mode, source maps are enabled automatically, so there's nothing you have to do to make use of them.
209-
If you need to include source maps in the bundle, you can do so by setting the `SOURCEMAPS` environment variable to `true` when you run the bundle command:
76+
== Notes on our Customized Version
21077

211-
$ SOURCEMAPS=true gulp bundle
78+
=== Tracking
79+
We have added our own tracking solution into `src/partials/head-scripts.hbs`. It has the URL hardcoded. it can be enabled by setting `site.keys.enable_tracking` to `true`/`false` in the Antora playbook.
21280

213-
In this case, the bundle will include the source maps, which can be used for debugging your production site.
81+
=== Highlight.js v10
82+
[Ticket](https://github.com/stackabletech/documentation/issues/232) - Due to the removal of HTML-passthru in v11 (which we need for [Callouts](https://docs.asciidoctor.org/asciidoc/latest/verbatim/callouts/)) the highlight.js has not been updated from v10. This also affects the Antora Default UI. Both decisions will be revisited when the upstream upgrade is available.
21483

21584
== Copyright and License
21685

0 commit comments

Comments
 (0)