=== 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:
$ 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.
== 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.
=== 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
=== 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:
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_.
README.adoc
gulpfile.js/
index.js
- ...
+ lib/
+ tasks/
package.json
yarn.lock
src/
...
vendor/
highlight.js
-preview-site-src/
+preview-src/
index.html
ui-model.yml
....
const bundleName = 'ui'
const buildDir = 'build'
-const previewSrcDir = 'preview-site-src'
+const previewSrcDir = 'preview-src'
const previewDestDir = 'public'
const srcDir = 'src'
const destDir = `${previewDestDir}/_`
+++ /dev/null
-= Hardware and Software Requirements
-Author Name
-:idprefix:
-:idseparator: -
-:!example-caption:
-
-Platonem complectitur mediocritatem ea eos.
-Ei nonumy deseruisse ius.
-Mel id omnes verear.
-Vis no velit audiam, sonet <<dependencies,praesent>> eum ne.
-*Prompta eripuit* nec ad.
-
-== Cu solet
-
-Nominavi luptatum eos, an vim hinc philosophia intellegebat.
-Lorem `expetenda` pertinacia et nec, wisi illud sonet qui ea.
-Eum an doctus <<liber-recusabo,maiestatis efficiantur>>.
-Eu mea inani iriure.
-
-[source,json]
-----
-{
- "name": "module-name",
- "version": "10.0.1",
- "description": "An example module to illustrate the usage of package.json",
- "author": "Author Name <author@example.com>",
- "scripts": {
- "test": "mocha",
- "lint": "eslint"
- }
-}
-----
-
-.Example paragraph syntax
-[source,asciidoc]
-----
-.Optional title
-[example]
-This is an example paragraph.
-----
-
-.Optional title
-[example]
-This is an example paragraph.
-
-How about some code?
-
-[source,js]
-----
-vfs
- .src('js/vendor/*.js', { cwd: 'src', cwdbase: true, read: false })
- .pipe(tap((file) => { // <1>
- file.contents = browserify(file.relative, { basedir: 'src', detectGlobals: false }).bundle()
- }))
- .pipe(buffer())
- .pipe(uglify())
- .pipe(gulp.dest('build'))
-----
-<1> The tap function is used to wiretap the data in the pipe.
-
-Cum dicat #putant# ne.
-Est in <<inline,reque>> homero principes, meis deleniti mediocrem ad has.
-Altera atomorum his ex, has cu elitr melius propriae.
-Eos suscipit scaevola at.
-
-....
-pom.xml
-src/
- main/
- java/
- HelloWorld.java
- test/
- java/
- HelloWorldTest.java
-....
-
-Select menu:File[Open Project] to open the project in your IDE.
-Per ea btn:[Cancel] inimicus.
-Ferri kbd:[F11] tacimates constituam sed ex, eu mea munere vituperata kbd:[Ctrl,T] constituam.
-
-.Sidebar
-****
-Platonem complectitur mediocritatem ea eos.
-Ei nonumy deseruisse ius.
-Mel id omnes verear.
-
-Altera atomorum his ex, has cu elitr melius propriae.
-Eos suscipit scaevola at.
-****
-
-=== Liber recusabo
-
-No sea, at invenire voluptaria mnesarchum has.
-Ex nam suas nemore dignissim, vel apeirian democritum et.
-At ornatus splendide sed, phaedrum omittantur usu an, vix an noster voluptatibus.
-
-. potenti donec cubilia tincidunt
-. etiam pulvinar inceptos velit quisque aptent himenaeos
-. lacus volutpat semper porttitor aliquet ornare primis nulla enim
-
-Natum facilisis theophrastus an duo.
-No sea, at invenire voluptaria mnesarchum has.
-
-* ultricies sociosqu tristique integer
-* lacus volutpat semper porttitor aliquet ornare primis nulla enim
-* etiam pulvinar inceptos velit quisque aptent himenaeos
-
-Eu sed antiopam gloriatur.
-Ea mea agam graeci philosophia.
-
-* [ ] todo
-* [x] done!
-
-Vis veri graeci legimus ad.
-
-sed::
-splendide sed
-
-mea::
-agam graeci
-
-At ornatus splendide sed.
-
-[#dependencies%autowidth]
-|===
-|Library |Version
-
-|eslint
-|^1.7.3
-
-|eslint-config-gulp
-|^2.0.0
-
-|expect
-|^1.20.2
-
-|istanbul
-|^0.4.3
-
-|istanbul-coveralls
-|^1.0.3
-
-|jscs
-|^2.3.5
-|===
-
-Cum dicat putant ne.
-Est in reque homero principes, meis deleniti mediocrem ad has.
-Altera atomorum his ex, has cu elitr melius propriae.
-Eos suscipit scaevola at.
-
-[TIP]
-This oughta do it!
-
-Cum dicat putant ne.
-Est in reque homero principes, meis deleniti mediocrem ad has.
-Altera atomorum his ex, has cu elitr melius propriae.
-Eos suscipit scaevola at.
-
-[NOTE]
-====
-You've been down _this_ road before.
-====
-
-Cum dicat putant ne.
-Est in reque homero principes, meis deleniti mediocrem ad has.
-Altera atomorum his ex, has cu elitr melius propriae.
-Eos suscipit scaevola at.
-
-[WARNING]
-====
-Watch out!
-====
-
-[CAUTION]
-====
-[#inline]#I wouldn't try that if I were you.#
-====
-
-[IMPORTANT]
-====
-Don't forget this step!
-====
-
-.Key Points to Remember
-[TIP]
-====
-If you installed the CLI and the default site generator globally, you can upgrade both of them with the same command.
-
- $ npm i -g @antora/cli @antora/site-generator-default
-====
-
-Nominavi luptatum eos, an vim hinc philosophia intellegebat.
-Eu mea inani iriure.
-
-[discrete]
-== Voluptua singulis
-
-Cum dicat putant ne.
-Est in reque homero principes, meis deleniti mediocrem ad has.
-Altera atomorum his ex, has cu elitr melius propriae.
-Eos suscipit scaevola at.
+++ /dev/null
-antoraVersion: '1.0.0'
-site:
- url: http://localhost:5252
- title: Brand Docs
- components:
- - name: abc
- title: Project ABC
- url: '#'
- versions:
- - &latest_version_abc
- url: '#'
- version: '1.1'
- displayVersion: '1.1'
- - url: '#'
- version: '1.0'
- displayVersion: '1.0'
- latestVersion: *latest_version_abc
- - &component
- name: xyz
- title: Project XYZ
- url: /xyz/6.0/index.html
- versions:
- - &latest_version_xyz
- url: /xyz/6.0/index.html
- version: '6.0'
- displayVersion: '6.0'
- - &component_version
- url: '#'
- version: '5.2'
- displayVersion: '5.2'
- - url: '#'
- version: '5.1'
- displayVersion: '5.1'
- - url: '#'
- version: '5.0'
- displayVersion: '5.0'
- latestVersion: *latest_version_xyz
- - name: 123
- title: Project 123
- url: '#'
- versions:
- - &latest_version_123
- url: '#'
- version: '2.2'
- displayVersion: '2.2'
- - url: '#'
- version: '2.1'
- displayVersion: '2.1'
- - url: '#'
- version: '2.0'
- displayVersion: '2.0'
- latestVersion: *latest_version_123
-page:
- title: Brand’s Hardware & Software Requirements
- url: /xyz/5.2/index.html
- component: *component
- componentVersion: *component_version
- version: '5.2'
- displayVersion: '5.2'
- module: ROOT
- home: false
- editUrl: http://example.com/project-xyz/blob/master/index.adoc
- breadcrumbs:
- - content: Quickstart
- url: '#'
- urlType: fragment
- - content: Brand’s Hardware & Software Requirements
- url: /xyz/5.2/index.html
- urlType: internal
- versions:
- - version: '6.0'
- displayVersion: '6.0'
- url: '#'
- - version: '5.2'
- displayVersion: '5.2'
- url: '#'
- - version: '5.1'
- displayVersion: '5.1'
- url: '#'
- - version: '5.0'
- displayVersion: '5.0'
- missing: true
- url: '#'
- navigation:
- - root: true
- content: Project XYZ
- url: '#'
- urlType: fragment
- items:
- - content: Quickstart
- url: '#'
- urlType: fragment
- items:
- - content: Brand’s Hardware & Software Requirements
- url: /xyz/5.2/index.html
- urlType: internal
- - title: IDE Integration
- url: '#'
- urlType: fragment
- - content: Liber Recusabo
- url: '#liber-recusabo'
- urlType: fragment
- - content: Reference
- items:
- - content: Keyboard Shortcuts
- url: '#'
- urlType: fragment
- - content: Importing and Exporting
- url: '#'
- urlType: fragment
--- /dev/null
+= Hardware and Software Requirements
+Author Name
+:idprefix:
+:idseparator: -
+:!example-caption:
+
+Platonem complectitur mediocritatem ea eos.
+Ei nonumy deseruisse ius.
+Mel id omnes verear.
+Vis no velit audiam, sonet <<dependencies,praesent>> eum ne.
+*Prompta eripuit* nec ad.
+
+== Cu solet
+
+Nominavi luptatum eos, an vim hinc philosophia intellegebat.
+Lorem `expetenda` pertinacia et nec, wisi illud sonet qui ea.
+Eum an doctus <<liber-recusabo,maiestatis efficiantur>>.
+Eu mea inani iriure.
+
+[source,json]
+----
+{
+ "name": "module-name",
+ "version": "10.0.1",
+ "description": "An example module to illustrate the usage of package.json",
+ "author": "Author Name <author@example.com>",
+ "scripts": {
+ "test": "mocha",
+ "lint": "eslint"
+ }
+}
+----
+
+.Example paragraph syntax
+[source,asciidoc]
+----
+.Optional title
+[example]
+This is an example paragraph.
+----
+
+.Optional title
+[example]
+This is an example paragraph.
+
+How about some code?
+
+[source,js]
+----
+vfs
+ .src('js/vendor/*.js', { cwd: 'src', cwdbase: true, read: false })
+ .pipe(tap((file) => { // <1>
+ file.contents = browserify(file.relative, { basedir: 'src', detectGlobals: false }).bundle()
+ }))
+ .pipe(buffer())
+ .pipe(uglify())
+ .pipe(gulp.dest('build'))
+----
+<1> The tap function is used to wiretap the data in the pipe.
+
+Cum dicat #putant# ne.
+Est in <<inline,reque>> homero principes, meis deleniti mediocrem ad has.
+Altera atomorum his ex, has cu elitr melius propriae.
+Eos suscipit scaevola at.
+
+....
+pom.xml
+src/
+ main/
+ java/
+ HelloWorld.java
+ test/
+ java/
+ HelloWorldTest.java
+....
+
+Select menu:File[Open Project] to open the project in your IDE.
+Per ea btn:[Cancel] inimicus.
+Ferri kbd:[F11] tacimates constituam sed ex, eu mea munere vituperata kbd:[Ctrl,T] constituam.
+
+.Sidebar
+****
+Platonem complectitur mediocritatem ea eos.
+Ei nonumy deseruisse ius.
+Mel id omnes verear.
+
+Altera atomorum his ex, has cu elitr melius propriae.
+Eos suscipit scaevola at.
+****
+
+=== Liber recusabo
+
+No sea, at invenire voluptaria mnesarchum has.
+Ex nam suas nemore dignissim, vel apeirian democritum et.
+At ornatus splendide sed, phaedrum omittantur usu an, vix an noster voluptatibus.
+
+. potenti donec cubilia tincidunt
+. etiam pulvinar inceptos velit quisque aptent himenaeos
+. lacus volutpat semper porttitor aliquet ornare primis nulla enim
+
+Natum facilisis theophrastus an duo.
+No sea, at invenire voluptaria mnesarchum has.
+
+* ultricies sociosqu tristique integer
+* lacus volutpat semper porttitor aliquet ornare primis nulla enim
+* etiam pulvinar inceptos velit quisque aptent himenaeos
+
+Eu sed antiopam gloriatur.
+Ea mea agam graeci philosophia.
+
+* [ ] todo
+* [x] done!
+
+Vis veri graeci legimus ad.
+
+sed::
+splendide sed
+
+mea::
+agam graeci
+
+At ornatus splendide sed.
+
+[#dependencies%autowidth]
+|===
+|Library |Version
+
+|eslint
+|^1.7.3
+
+|eslint-config-gulp
+|^2.0.0
+
+|expect
+|^1.20.2
+
+|istanbul
+|^0.4.3
+
+|istanbul-coveralls
+|^1.0.3
+
+|jscs
+|^2.3.5
+|===
+
+Cum dicat putant ne.
+Est in reque homero principes, meis deleniti mediocrem ad has.
+Altera atomorum his ex, has cu elitr melius propriae.
+Eos suscipit scaevola at.
+
+[TIP]
+This oughta do it!
+
+Cum dicat putant ne.
+Est in reque homero principes, meis deleniti mediocrem ad has.
+Altera atomorum his ex, has cu elitr melius propriae.
+Eos suscipit scaevola at.
+
+[NOTE]
+====
+You've been down _this_ road before.
+====
+
+Cum dicat putant ne.
+Est in reque homero principes, meis deleniti mediocrem ad has.
+Altera atomorum his ex, has cu elitr melius propriae.
+Eos suscipit scaevola at.
+
+[WARNING]
+====
+Watch out!
+====
+
+[CAUTION]
+====
+[#inline]#I wouldn't try that if I were you.#
+====
+
+[IMPORTANT]
+====
+Don't forget this step!
+====
+
+.Key Points to Remember
+[TIP]
+====
+If you installed the CLI and the default site generator globally, you can upgrade both of them with the same command.
+
+ $ npm i -g @antora/cli @antora/site-generator-default
+====
+
+Nominavi luptatum eos, an vim hinc philosophia intellegebat.
+Eu mea inani iriure.
+
+[discrete]
+== Voluptua singulis
+
+Cum dicat putant ne.
+Est in reque homero principes, meis deleniti mediocrem ad has.
+Altera atomorum his ex, has cu elitr melius propriae.
+Eos suscipit scaevola at.
--- /dev/null
+antoraVersion: '1.0.0'
+site:
+ url: http://localhost:5252
+ title: Brand Docs
+ components:
+ - name: abc
+ title: Project ABC
+ url: '#'
+ versions:
+ - &latest_version_abc
+ url: '#'
+ version: '1.1'
+ displayVersion: '1.1'
+ - url: '#'
+ version: '1.0'
+ displayVersion: '1.0'
+ latestVersion: *latest_version_abc
+ - &component
+ name: xyz
+ title: Project XYZ
+ url: /xyz/6.0/index.html
+ versions:
+ - &latest_version_xyz
+ url: /xyz/6.0/index.html
+ version: '6.0'
+ displayVersion: '6.0'
+ - &component_version
+ url: '#'
+ version: '5.2'
+ displayVersion: '5.2'
+ - url: '#'
+ version: '5.1'
+ displayVersion: '5.1'
+ - url: '#'
+ version: '5.0'
+ displayVersion: '5.0'
+ latestVersion: *latest_version_xyz
+ - name: 123
+ title: Project 123
+ url: '#'
+ versions:
+ - &latest_version_123
+ url: '#'
+ version: '2.2'
+ displayVersion: '2.2'
+ - url: '#'
+ version: '2.1'
+ displayVersion: '2.1'
+ - url: '#'
+ version: '2.0'
+ displayVersion: '2.0'
+ latestVersion: *latest_version_123
+page:
+ title: Brand’s Hardware & Software Requirements
+ url: /xyz/5.2/index.html
+ component: *component
+ componentVersion: *component_version
+ version: '5.2'
+ displayVersion: '5.2'
+ module: ROOT
+ home: false
+ editUrl: http://example.com/project-xyz/blob/master/index.adoc
+ breadcrumbs:
+ - content: Quickstart
+ url: '#'
+ urlType: fragment
+ - content: Brand’s Hardware & Software Requirements
+ url: /xyz/5.2/index.html
+ urlType: internal
+ versions:
+ - version: '6.0'
+ displayVersion: '6.0'
+ url: '#'
+ - version: '5.2'
+ displayVersion: '5.2'
+ url: '#'
+ - version: '5.1'
+ displayVersion: '5.1'
+ url: '#'
+ - version: '5.0'
+ displayVersion: '5.0'
+ missing: true
+ url: '#'
+ navigation:
+ - root: true
+ content: Project XYZ
+ url: '#'
+ urlType: fragment
+ items:
+ - content: Quickstart
+ url: '#'
+ urlType: fragment
+ items:
+ - content: Brand’s Hardware & Software Requirements
+ url: /xyz/5.2/index.html
+ urlType: internal
+ - title: IDE Integration
+ url: '#'
+ urlType: fragment
+ - content: Liber Recusabo
+ url: '#liber-recusabo'
+ urlType: fragment
+ - content: Reference
+ items:
+ - content: Keyboard Shortcuts
+ url: '#'
+ urlType: fragment
+ - content: Importing and Exporting
+ url: '#'
+ urlType: fragment
projects / eg-antora.git / commitdiff