Skip to content

Commit d6c4472

Browse files
authored
Merge pull request #1 from settermjd/update-readme
Updated the README to reflect the ownCloud Antora build better
2 parents 3d719b6 + db542df commit d6c4472

File tree

1 file changed

+9
-16
lines changed

1 file changed

+9
-16
lines changed

README.adoc

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,9 @@
33
:experimental:
44
:hide-uri-scheme:
55
// 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
107
// External URIs:
8+
:uri-antora-default-ui: https://gitlab.com/antora/antora-ui-default
119
:uri-antora: https://antora.org
1210
:uri-git: https://git-scm.com
1311
:uri-git-dl: {uri-git}/downloads
@@ -18,27 +16,22 @@
1816
:uri-nvm-install: {uri-nvm}#installation
1917
:uri-yarn: https://yarnpkg.com
2018

21-
image:{img-ci-status}[CI Status (GitLab CI), link={uri-ci-pipelines}]
2219

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.
2521

26-
== Use the Default UI
22+
== Use the Theme
2723

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:
2925

3026
[source,yaml,subs=attributes+]
3127
----
3228
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
3430
----
3531

36-
Read on to learn how to use your own build of the default UI.
37-
3832
== Quickstart
3933

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.
4235

4336
=== Prerequisites
4437

@@ -66,7 +59,7 @@ Next, make sure that you have Node 8 installed.
6659
If this command fails with an error, you don't have Node installed.
6760
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.
6861

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.
7063
Follow the {uri-nvm-install}[nvm installation instructions] to set up nvm on your machine.
7164

7265
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:
110103
$ git clone {uri-project} &&
111104
cd "`basename $_`"
112105

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.
114107
Stay in this project folder in order to initialize the project using Yarn.
115108

116109
Use Yarn to install the project's dependencies.

0 commit comments

Comments
 (0)