|
3 | 3 | :experimental:
|
4 | 4 | :hide-uri-scheme:
|
5 | 5 | // Project URIs:
|
6 |
| -:uri-project: https://gitlab.com/antora/antora-ui-default |
7 |
| -:uri-preview: https://antora.gitlab.io/antora-ui-default |
8 |
| -:uri-ci-pipelines: {uri-project}/pipelines |
9 |
| -:img-ci-status: {uri-project}/badges/master/pipeline.svg |
| 6 | +:uri-project: https://github.com/settermjd/docs-ui |
10 | 7 | // External URIs:
|
| 8 | +:uri-antora-default-ui: https://gitlab.com/antora/antora-ui-default |
11 | 9 | :uri-antora: https://antora.org
|
12 | 10 | :uri-git: https://git-scm.com
|
13 | 11 | :uri-git-dl: {uri-git}/downloads
|
|
18 | 16 | :uri-nvm-install: {uri-nvm}#installation
|
19 | 17 | :uri-yarn: https://yarnpkg.com
|
20 | 18 |
|
21 |
| -image:{img-ci-status}[CI Status (GitLab CI), link={uri-ci-pipelines}] |
22 | 19 |
|
23 |
| -This project is an archetype that demonstrates how to produce a UI bundle for use in a documentation site generated with {uri-antora}[Antora]. |
24 |
| -You can see a preview of the default UI at {uri-preview}. |
| 20 | +This project is a custom version of {uri-antora-default-ui}[the Antora Default UI], for the Antora version of the ownCloud documentation. |
25 | 21 |
|
26 |
| -== Use the Default UI |
| 22 | +== Use the Theme |
27 | 23 |
|
28 |
| -If you want to use the default UI for your Antora-generated site, add the following UI configuration to your playbook: |
| 24 | +To use the theme with the ownCloud Antora docs, add the following UI configuration to your playbook: |
29 | 25 |
|
30 | 26 | [source,yaml,subs=attributes+]
|
31 | 27 | ----
|
32 | 28 | ui:
|
33 |
| - bundle: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable |
| 29 | + bundle: https://github.com/settermjd/docs-ui/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable |
34 | 30 | ----
|
35 | 31 |
|
36 |
| -Read on to learn how to use your own build of the default UI. |
37 |
| - |
38 | 32 | == Quickstart
|
39 | 33 |
|
40 |
| -This section offers a basic tutorial for learning how to preview the default UI and bundle it for use with Antora. |
41 |
| -A more comprehensive tutorial will be made available in the documentation. |
| 34 | +This section offers a basic tutorial for learning how to preview the theme and bundle it for use with the ownCloud Antora docs. |
42 | 35 |
|
43 | 36 | === Prerequisites
|
44 | 37 |
|
@@ -66,7 +59,7 @@ Next, make sure that you have Node 8 installed.
|
66 | 59 | If this command fails with an error, you don't have Node installed.
|
67 | 60 | 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.
|
68 | 61 |
|
69 |
| -While you can install Node from the official packages, we strongly recommend that you use {uri-nvm}[nvm] (Node Version Manager) to install and manage Node. |
| 62 | +While you can install Node from the official packages, we strongly recommend that you use {uri-nvm}[nvm] (_Node Version Manager_) to install and manage Node. |
70 | 63 | Follow the {uri-nvm-install}[nvm installation instructions] to set up nvm on your machine.
|
71 | 64 |
|
72 | 65 | Once you've installed nvm, open a new terminal and install Node 8 using the following command:
|
@@ -110,7 +103,7 @@ Clone the default UI project using git:
|
110 | 103 | $ git clone {uri-project} &&
|
111 | 104 | cd "`basename $_`"
|
112 | 105 |
|
113 |
| -The example above clones Antora's default UI project and then switches to the project folder on your filesystem. |
| 106 | +The example above clones the custom Antora ownCloud UI theme and then switches to the project folder on your filesystem. |
114 | 107 | Stay in this project folder in order to initialize the project using Yarn.
|
115 | 108 |
|
116 | 109 | Use Yarn to install the project's dependencies.
|
|
0 commit comments