You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
4
12
5
13
== Use the Default UI
6
14
@@ -20,19 +28,19 @@ If the URL were to be unique, this setting would not be required.
20
28
21
29
Read on to learn how to customize the default UI for your own documentation.
22
30
23
-
== Development Quickstart
31
+
== Quickstart
24
32
25
33
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.
26
34
A more comprehensive tutorial can be found in the documentation at {url-antora-docs}.
27
35
28
-
=== Prerequisites
36
+
=== 1. Prerequisites
29
37
30
38
To preview and bundle the default UI, you need the following software on your computer:
31
39
32
40
* {url-nodejs}[Node.js] (commands: `node` and `npm`)
33
41
* {url-gulp}[Gulp CLI] (command: `gulp`)
34
42
35
-
==== Node.js
43
+
==== 1.1. Node.js
36
44
37
45
Next, make sure that you have Node.js installed (which also provides npm).
38
46
@@ -57,7 +65,7 @@ To make Node.js 10 the default in new terminals, type:
57
65
58
66
Now that you have Node.js installed, you can proceed with installing the Gulp CLI.
59
67
60
-
==== Gulp CLI
68
+
==== 1.2. Gulp CLI
61
69
62
70
You'll need the Gulp command-line interface (CLI) to run the build.
63
71
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:
70
78
71
79
$ gulp --version
72
80
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
-
81
81
Now that you have the prerequisites installed, you can fetch and build the UI project.
82
82
83
-
=== Clone and Initialize the UI Project
84
-
85
-
Clone the default UI project using git:
83
+
=== 2. Clone Repo and install dependencies
86
84
87
-
[subs=attributes+]
88
-
$ git clone {url-project} &&
89
-
cd "`basename $_`"
85
+
[subs=attributes]
86
+
$ git clone https://github.com/{repo}
87
+
$ cd {project}
90
88
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:
93
90
94
-
Use npm to install the project's dependencies inside the project.
95
-
In your terminal, execute the following command:
91
+
$ npm i
96
92
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
110
94
111
95
The default UI project is configured to preview offline.
112
96
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
132
116
133
117
Press kbd:[Ctrl+C] to stop the preview server and end the continuous build.
134
118
135
-
=== Package for Use with Antora
119
+
=== 4. Package for Use with Antora
136
120
137
121
If you need to package the UI so you can use it to generate the documentation site locally, run the following command:
138
122
@@ -171,7 +155,3 @@ Copyright (C) 2017-present OpenDevise Inc. and the Antora Project.
171
155
172
156
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).
173
157
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