summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDan Allen <dan@opendevise.com>2018-12-30 14:41:33 -0700
committerDan Allen <dan@opendevise.com>2018-12-30 15:08:32 -0700
commitf8980ea2b303dc8a6a809045c1c2f06c7053ac39 (patch)
treeb0921dc7899297c2aab4b74430bb190acb04c599
parent97a1d516e243585b2fa7afd50b84daf73488bd3d (diff)
downloadalpine-antora-theme-f8980ea2b303dc8a6a809045c1c2f06c7053ac39.tar.bz2
alpine-antora-theme-f8980ea2b303dc8a6a809045c1c2f06c7053ac39.tar.xz
rename preview-site-src folder to preview-src
-rw-r--r--README.adoc4
-rw-r--r--docs/modules/ROOT/pages/build-preview-ui.adoc12
-rw-r--r--docs/modules/ROOT/pages/index.adoc5
-rw-r--r--gulpfile.js/index.js2
-rw-r--r--preview-src/404.adoc (renamed from preview-site-src/404.adoc)0
-rw-r--r--preview-src/index.adoc (renamed from preview-site-src/index.adoc)0
-rw-r--r--preview-src/ui-model.yml (renamed from preview-site-src/ui-model.yml)0
7 files changed, 16 insertions, 7 deletions
diff --git a/README.adoc b/README.adoc
index a4218b7..3a476ba 100644
--- a/README.adoc
+++ b/README.adoc
@@ -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.
diff --git a/docs/modules/ROOT/pages/build-preview-ui.adoc b/docs/modules/ROOT/pages/build-preview-ui.adoc
index 3daab1c..291f8bb 100644
--- a/docs/modules/ROOT/pages/build-preview-ui.adoc
+++ b/docs/modules/ROOT/pages/build-preview-ui.adoc
@@ -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_.
diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
index 4258c3f..6d2afe3 100644
--- a/docs/modules/ROOT/pages/index.adoc
+++ b/docs/modules/ROOT/pages/index.adoc
@@ -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
....
diff --git a/gulpfile.js/index.js b/gulpfile.js/index.js
index cf95f35..11f64ac 100644
--- a/gulpfile.js/index.js
+++ b/gulpfile.js/index.js
@@ -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}/_`
diff --git a/preview-site-src/404.adoc b/preview-src/404.adoc
index e69de29..e69de29 100644
--- a/preview-site-src/404.adoc
+++ b/preview-src/404.adoc
diff --git a/preview-site-src/index.adoc b/preview-src/index.adoc
index 862e646..862e646 100644
--- a/preview-site-src/index.adoc
+++ b/preview-src/index.adoc
diff --git a/preview-site-src/ui-model.yml b/preview-src/ui-model.yml
index 1aca0f2..1aca0f2 100644
--- a/preview-site-src/ui-model.yml
+++ b/preview-src/ui-model.yml