Skip to content

Commit d516b16

Browse files
authored
Update README.adoc
1 parent bd7b93a commit d516b16

File tree

1 file changed

+21
-41
lines changed

1 file changed

+21
-41
lines changed

README.adoc

Lines changed: 21 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
1+
:url-nodejs: https://nodejs.org/en/download/
2+
:url-nvm: https://github.com/nvm-sh/nvm
3+
:url-nvm-install: https://github.com/nvm-sh/nvm#installing-and-updating
4+
:url-gulp: https://gulpjs.com/docs/en/getting-started/quick-start
5+
:org: synthesized-io
6+
:project: docs-ui
7+
:repo: {org}/{project}
8+
19
= Synthesized Docs UI
210

3-
This repository contains the css and js files used for styling Synthesized's Docs [synthesized-io/synthesized-io.github.io](https://github.com/synthesized-io/synthesized-io.github.io). It produces a UI bundle that is referenced by the Antora documentation builder.
11+
This repository contains the css and js files used for styling Synthesized's Docs https://github.com/synthesized-io/synthesized-io.github.io[synthesized-io/synthesized-io.github.io]. It produces a UI bundle that is referenced by the Antora documentation builder.
412

513
== Use the Default UI
614

@@ -20,19 +28,19 @@ If the URL were to be unique, this setting would not be required.
2028

2129
Read on to learn how to customize the default UI for your own documentation.
2230

23-
== Development Quickstart
31+
== Quickstart
2432

2533
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.
2634
A more comprehensive tutorial can be found in the documentation at {url-antora-docs}.
2735

28-
=== Prerequisites
36+
=== 1. Prerequisites
2937

3038
To preview and bundle the default UI, you need the following software on your computer:
3139

3240
* {url-nodejs}[Node.js] (commands: `node` and `npm`)
3341
* {url-gulp}[Gulp CLI] (command: `gulp`)
3442

35-
==== Node.js
43+
==== 1.1. Node.js
3644

3745
Next, make sure that you have Node.js installed (which also provides npm).
3846

@@ -57,7 +65,7 @@ To make Node.js 10 the default in new terminals, type:
5765

5866
Now that you have Node.js installed, you can proceed with installing the Gulp CLI.
5967

60-
==== Gulp CLI
68+
==== 1.2. Gulp CLI
6169

6270
You'll need the Gulp command-line interface (CLI) to run the build.
6371
The Gulp CLI package provides the `gulp` command which, in turn, executes the version of Gulp declared by the project.
@@ -70,43 +78,19 @@ Verify the Gulp CLI is installed and on your PATH by running:
7078

7179
$ gulp --version
7280

73-
If you prefer to install global packages using Yarn, run this command instead:
74-
75-
$ yarn global add gulp-cli
76-
77-
Alternately, you can use the `gulp` command that is installed by the project's dependencies.
78-
79-
$ $(npm bin)/gulp --version
80-
8181
Now that you have the prerequisites installed, you can fetch and build the UI project.
8282

83-
=== Clone and Initialize the UI Project
84-
85-
Clone the default UI project using git:
83+
=== 2. Clone Repo and install dependencies
8684

87-
[subs=attributes+]
88-
$ git clone {url-project} &&
89-
cd "`basename $_`"
85+
[subs=attributes]
86+
$ git clone https://github.com/{repo}
87+
$ cd {project}
9088

91-
The example above clones Antora's default UI project and then switches to the project folder on your filesystem.
92-
Stay in this project folder when executing all subsequent commands.
89+
Use npm to install the project’s dependencies inside the project. In your terminal, execute the following command:
9390

94-
Use npm to install the project's dependencies inside the project.
95-
In your terminal, execute the following command:
91+
$ npm i
9692

97-
$ npm install
98-
99-
This command installs the dependencies listed in [.path]_package.json_ into the [.path]_node_modules/_ folder inside the project.
100-
This folder does not get included in the UI bundle and should _not_ be committed to the source control repository.
101-
102-
[TIP]
103-
====
104-
If you prefer to install packages using Yarn, run this command instead:
105-
106-
$ yarn
107-
====
108-
109-
=== Preview the UI
93+
=== 3. Preview the UI
11094

11195
The default UI project is configured to preview offline.
11296
The files in the [.path]_preview-src/_ folder provide the sample content that allow you to see the UI in action.
@@ -132,7 +116,7 @@ This works by monitoring the project for changes, running the `preview:build` ta
132116

133117
Press kbd:[Ctrl+C] to stop the preview server and end the continuous build.
134118

135-
=== Package for Use with Antora
119+
=== 4. Package for Use with Antora
136120

137121
If you need to package the UI so you can use it to generate the documentation site locally, run the following command:
138122

@@ -171,7 +155,3 @@ Copyright (C) 2017-present OpenDevise Inc. and the Antora Project.
171155

172156
Use of this software is granted under the terms of the https://www.mozilla.org/en-US/MPL/2.0/[Mozilla Public License Version 2.0] (MPL-2.0).
173157
See link:LICENSE[] to find the full license text.
174-
175-
== Authors
176-
177-
Development of Antora is led and sponsored by {url-opendevise}[OpenDevise Inc].

0 commit comments

Comments
 (0)