Skip to content

Commit

Permalink
Merge pull request #2 from settermjd/revise-readme
Browse files Browse the repository at this point in the history
Further modifications to the README
  • Loading branch information
settermjd authored Aug 2, 2018
2 parents d6c4472 + 9c4f5c2 commit ba55cc4
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Antora Default UI
= ownCloud Antora-based Docs Default UI
// Settings:
:experimental:
:hide-uri-scheme:
Expand All @@ -19,9 +19,9 @@

This project is a custom version of {uri-antora-default-ui}[the Antora Default UI], for the Antora version of the ownCloud documentation.

== Use the Theme
== Use the ownCloud Antora-based Docs Default UI

To use the theme with the ownCloud Antora docs, add the following UI configuration to your playbook:
To use the ownCloud Antora-based Docs Default UI with the ownCloud Antora docs, add the following UI configuration to your playbook:

[source,yaml,subs=attributes+]
----
Expand All @@ -31,7 +31,7 @@ ui:

== Quickstart

This section offers a basic tutorial for learning how to preview the theme and bundle it for use with the ownCloud Antora docs.
This section offers a basic tutorial for learning how to preview the ownCloud Antora-based Docs Default UI and bundle it for use with the ownCloud Antora docs.

=== Prerequisites

Expand Down Expand Up @@ -103,7 +103,7 @@ Clone the default UI project using git:
$ git clone {uri-project} &&
cd "`basename $_`"

The example above clones the custom Antora ownCloud UI theme and then switches to the project folder on your filesystem.
The example above clones the ownCloud Antora-based Docs Default UI 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.
Expand Down

0 comments on commit ba55cc4

Please sign in to comment.