Commit f8980ea2 authored by Dan Allen's avatar Dan Allen

rename preview-site-src folder to preview-src

parent 97a1d516
......@@ -126,7 +126,7 @@ This folder does not get included in the UI bundle.
=== Preview the UI
The default UI project is configured to preview offline.
That's what the files in the [.path]_preview-site-src/_ folder are for.
That's what the files in the [.path]_preview-src/_ folder are for.
This folder contains HTML file fragments that provide a representative sample of content from the site.
To build the UI and preview it in a local web server, run the `preview` command:
......@@ -162,6 +162,8 @@ If you have the preview running, and you want to bundle without causing the prev
$ gulp bundle:pack
The UI bundle will again be available at [.path]_build/ui-bundle.zip_.
== Copyright and License
Copyright (C) 2017-2018 OpenDevise Inc. and the Antora Project.
......
......@@ -10,7 +10,7 @@ endif::[]
== Build Preview Site
Once you've modified the site UI, the first thing you'll want to do is check out how it looks.
That's what the files in the [.path]_preview-site-src/_ folder are for.
That's what the files in the [.path]_preview-src/_ folder are for.
This folder contains HTML file fragments that provide a representative sample of content from the site.
The preview saves you from having to generate the whole site just to test the UI.
These files should give you an idea of how the UI will look when applied to the actual site.
......@@ -24,7 +24,7 @@ The next two sections explain how to use these modes.
=== Build Once
To build the UI once for preview, then stop, execute the `build-preview` task using the following command:
To build the UI once for preview, then stop, execute the following command:
$ gulp preview:build
......@@ -33,7 +33,7 @@ To view the preview pages, navigate to the HTML pages in the [.path]_public_ dir
=== Build Continuously
To avoid the need to run the `preview:build` task over and over, you can use the `preview` command instead to have it run continuously.
To avoid the need to run the `preview:build` task over and over while developing, you can use the `preview` command instead to have it run continuously.
This task also launches a local HTTP server so updates get synchronized with the browser (i.e., "`live reload`").
To launch the preview server, execute the following command:
......@@ -65,3 +65,9 @@ The `bundle` command also invokes the `lint` command to check that the CSS and J
The UI bundle will be available at [.path]_build/ui-bundle.zip_.
You can then point Antora at this bundle using the `--ui-bundle-url` command-line option.
If you have the preview running, and you want to bundle without causing the preview to be clobbered, use:
$ gulp bundle:pack
The UI bundle will again be available at [.path]_build/ui-bundle.zip_.
......@@ -93,7 +93,8 @@ Here's how the files are structured in the UI project:
README.adoc
gulpfile.js/
index.js
...
lib/
tasks/
package.json
yarn.lock
src/
......@@ -122,7 +123,7 @@ src/
...
vendor/
highlight.js
preview-site-src/
preview-src/
index.html
ui-model.yml
....
......
......@@ -5,7 +5,7 @@ const task = require('./lib/task')
const bundleName = 'ui'
const buildDir = 'build'
const previewSrcDir = 'preview-site-src'
const previewSrcDir = 'preview-src'
const previewDestDir = 'public'
const srcDir = 'src'
const destDir = `${previewDestDir}/_`
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment