diff options
Diffstat (limited to 'README.adoc')
| -rw-r--r-- | README.adoc | 43 |
1 files changed, 20 insertions, 23 deletions
diff --git a/README.adoc b/README.adoc index ee2fe0b..b037252 100644 --- a/README.adoc +++ b/README.adoc @@ -47,7 +47,7 @@ A more comprehensive tutorial will be made available in the documentation. To preview and bundle the default UI, you need the following software on your computer: * {uri-git}[git] (command: `git`) -* {uri-node}[Node 8] (command: `node`) +* {uri-node}[Node] (command: `node`) * {uri-gulp}[Gulp CLI] (command: `gulp`) * {uri-yarn}[Yarn] (command: `yarn`) @@ -59,31 +59,31 @@ First, make sure you have git installed. If not, {uri-git-dl}[download and install] the git package for your system. -==== Node 8 +==== Node -Next, make sure that you have Node 8 installed. +Next, make sure that you have Node.js (herein "`Node`") installed. $ node --version If this command fails with an error, you don't have Node installed. -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. +If the command doesn't report a Node LTS version (e.g., v10.14.2), you don't have a suitable version of Node installed. 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. Follow the {uri-nvm-install}[nvm installation instructions] to set up nvm on your machine. -Once you've installed nvm, open a new terminal and install Node 8 using the following command: +Once you've installed nvm, open a new terminal and install Node 10 using the following command: - $ nvm install 8 + $ nvm install 10 You can switch to this version of Node at any time using the following command: - $ nvm use 8 + $ nvm use 10 -To make Node 8 the default in new terminals, type: +To make Node 10 the default in new terminals, type: - $ nvm alias default 8 + $ nvm alias default 10 -Now that you have Node 8 installed, you can proceed with installing the Gulp CLI and Yarn. +Now that you have Node 10 installed, you can proceed with installing the Gulp CLI and Yarn. ==== Gulp CLI @@ -133,33 +133,30 @@ To build the UI and preview it in a local web server, run the `preview` command: $ gulp preview -You'll see two URLs listed in the output of this command: +You'll see a URL listed in the output of this command: .... -[BS] Access URLs: - ---------------------------------- - Local: http://localhost:5252 - External: http://192.168.1.7:5252 - ---------------------------------- -[BS] Serving files from: build -[BS] Watching files... +[12:59:28] Starting 'preview:serve'... +[12:59:28] Starting server... +[12:59:28] Server started http://localhost:5252 +[12:59:28] Running server .... -Navigate to the first URL to see the preview site. +Navigate to that URL to view the preview site. While this command is running, any changes you make to the source files will be instantly reflected in the browser. -This works by monitoring the project for changes, running the `build` task if a change is detected, and sending the updates to the browser. +This works by monitoring the project for changes, running the `preview:build` task if a change is detected, and sending the updates to the browser. Press kbd:[Ctrl+C] to stop the preview server and end the continuous build. === Package for Use with Antora -If you need to package the UI in order to preview the UI on the real site in local development, run the following command: +If you need to bundle the UI in order to preview the UI on the real site in local development, run the following command: - $ gulp pack + $ gulp bundle The UI bundle will be available at [.path]_build/ui-bundle.zip_. -You can then point Antora at this bundle using the `--ui-bundle` command-line option. +You can then point Antora at this bundle using the `--ui-bundle-url` command-line option. == Copyright and License |