Currently in prototype, this project will be used to generate the UI for the next version of the MuleSoft documentation site. You can find a preview of this UI online at cb-docs-ui.netlify.com.
To use this UI with Antora, first download the UI bundle from the following URL and save it to the root of the project:
|
Note
|
It’s necessary to download the UI bundle manually since it’s stored in a private repository on GitHub. |
Next, add the following configuration to your playbook file:
ui:
bundle:
url: ./ui-bundle.zipRead on to learn how to build the UI from source.
This section offers a basic tutorial for learning how to preview the UI and bundle it for use with Antora.
To preview and bundle the UI, you need the following software on your computer:
First, make sure you have git installed.
$ git --version
If not, download and install the git package for your system.
Next, make sure that you have Node 8 installed.
$ node --version
If this command fails with an error, you don’t have Node installed. If the command doesn’t report a Node 8 version (e.g., v8.9.4), you don’t have a suitable version of Node installed.
While you can install Node from the official packages, we strongly recommend that you use nvm (Node Version Manager) to install and manage Node. Follow the nvm installation instructions to set up nvm on your machine.
Once you’ve installed nvm, open a new terminal and install Node 8 using the following command:
$ nvm install 8
You can switch to this version of Node at any time using the following command:
$ nvm use 8
To make Node 8 the default in new terminals, type:
$ nvm alias default 8
Now that you have Node 8 installed, you can proceed with installing the Gulp CLI and Yarn.
Next, you’ll need the Gulp command-line interface (CLI).
This package provides the gulp command which executes the version of Gulp declared by the project.
You should install the Gulp CLI globally (which resolves to a location in your user directory if you’re using nvm) using the following command:
$ npm install -g gulp-cli
Finally, you’ll need Yarn, which is the preferred package manager for the Node ecosystem.
You should install Yarn globally (which resolves to a location in your user directory if you’re using nvm) using the following command:
$ npm install -g yarn
Now that you have the prerequisites installed, you can fetch and build the default UI project.
Clone the default UI project using git:
$ git clone https://github.com/couchbase/docs-ui && cd "`basename $_`"
The example above clones Antora’s default UI project and then switches to the project folder on your filesystem. Stay in this project folder in order to initialize the project using Yarn.
Use Yarn to install the project’s dependencies. In your terminal, execute the following command (while inside the project folder):
$ yarn install
This command installs the dependencies listed in package.json into the node_modules/ folder inside the project. This folder does not get included in the UI bundle.
The UI project is configured to preview offline. That’s what the files in the preview-site-src/ folder are for. This folder contains HTML file fragments that provide a representative sample of content from the site.
To build the UI and preview it in a local web server, run the preview command:
$ gulp preview
You’ll see a URL listed in the output of this command:
[18:24:29] Server started http://localhost:5252 [18:24:29] Running server
Navigate to the 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 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.
If you need to package the UI in order to preview the UI on the real site in local development, run the following command:
$ gulp pack
The UI bundle will be available at build/ui-bundle.zip.
You can then point Antora at this bundle using the --ui-bundle command-line option.