diff --git a/README.adoc b/README.adoc index 7d13010..9d32e11 100644 --- a/README.adoc +++ b/README.adoc @@ -27,6 +27,12 @@ You can see a preview of the default UI at {url-preview}. While the default UI is ready to be used with Antora, the intent is that you'll fork it and customize it for your own needs. It's intentionally minimalistic so as to give you a good starting point without requiring too much effort to customize. +== Code of Conduct + +The Antora project and its project spaces are governed by our https://gitlab.com/antora/antora/-/blob/master/CODE-OF-CONDUCT.adoc[Code of Conduct]. +By participating, you're agreeing to honor this code. +Let's work together to make this a welcoming, professional, inclusive, and safe environment for everyone. + == Use the Default UI If you want to simply use the default UI for your Antora-generated site, add the following UI configuration to your playbook: @@ -195,15 +201,15 @@ These map files sit adjacent to the combined files in the build folder. The mapping they provide allows the debugger to present the original source rather than the obfuscated file, an essential tool for debugging. In preview mode, source maps are enabled automatically, so there's nothing you have to do to make use of them. -If you need to include source maps in the bundle, you can do so by setting the `SOURCEMAPS` environment varible to `true` when you run the bundle command: +If you need to include source maps in the bundle, you can do so by setting the `SOURCEMAPS` environment variable to `true` when you run the bundle command: $ SOURCEMAPS=true gulp bundle -In this case, the bundle will include the source maps, which can be used for debuggging your production site. +In this case, the bundle will include the source maps, which can be used for debugging your production site. == Copyright and License -Copyright (C) 2017-2019 OpenDevise Inc. and the Antora Project. +Copyright (C) 2017-present OpenDevise Inc. and the Antora Project. 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). See link:LICENSE[] to find the full license text. diff --git a/docs/modules/ROOT/pages/build-preview-ui.adoc b/docs/modules/ROOT/pages/build-preview-ui.adoc index c4313a5..36251a3 100644 --- a/docs/modules/ROOT/pages/build-preview-ui.adoc +++ b/docs/modules/ROOT/pages/build-preview-ui.adoc @@ -1,8 +1,4 @@ = Build a UI Project for Local Preview -// Settings: -:idprefix: -:idseparator: - -:experimental: == Build Preview Site diff --git a/docs/modules/ROOT/pages/development-workflow.adoc b/docs/modules/ROOT/pages/development-workflow.adoc index a48915b..4eb57c2 100644 --- a/docs/modules/ROOT/pages/development-workflow.adoc +++ b/docs/modules/ROOT/pages/development-workflow.adoc @@ -1,7 +1,4 @@ = UI Development Workflow -// Settings: -:idprefix: -:idseparator: - // This section provides information about some of the UI files you'll be modifying and how to prepare and submit those changes. diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index c80f540..f78022e 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -1,23 +1,20 @@ = Antora Default UI // Settings: -:idprefix: -:idseparator: - -:experimental: :hide-uri-scheme: -// URIs: -:uri-antora: https://antora.org -:uri-repo: https://gitlab.com/antora/antora-ui-default -:uri-preview: https://antora.gitlab.io/antora-ui-default -:uri-hbs: http://handlebarsjs.com -:uri-gulp: http://gulpjs.com -:uri-npm: https://npmjs.com -:uri-node: https://nodejs.org -:uri-nvm: https://github.com/creationix/nvm -:uri-nvm-install: {uri-nvm}#installation -:uri-git: https://git-scm.com -:uri-git-dl: {uri-git}/downloads - -This project produces the {uri-preview}[default UI bundle] for documentation sites generated with {uri-antora}[Antora]. +// URLs: +:url-antora: https://antora.org +:url-repo: https://gitlab.com/antora/antora-ui-default +:url-preview: https://antora.gitlab.io/antora-ui-default +:url-hbs: https://handlebarsjs.com +:url-gulp: https://gulpjs.com +:url-npm: https://npmjs.com +:url-node: https://nodejs.org +:url-nvm: https://github.com/creationix/nvm +:url-nvm-install: {url-nvm}#installation +:url-git: https://git-scm.com +:url-git-dl: {url-git}/downloads + +This project produces the {url-preview}[default UI bundle] for documentation sites generated with {url-antora}[Antora]. It contains the UI assets (page templates, CSS, JavaScript, images, etc.) and a Gulp build script. The build can be used to preview the UI locally (featuring live updates), or to package it for consumption by the Antora site generator. @@ -44,16 +41,16 @@ The Antora UI consists of the following file types that are used to structure an To understand how the UI works, let's begin by surveying the primary technologies used by the UI. Handlebars (file extension: `.hbs`):: -{uri-hbs}[Handlebars] is a "`logic-less`" templating engine used to create HTML from template files. +{url-hbs}[Handlebars] is a "`logic-less`" templating engine used to create HTML from template files. Templates contain placeholders (i.e., mustache expressions like `+{{{page.title}}}+`) into which content is injected from a model. They also accommodate simple logic expressions for repeating content or including it conditionally (e.g., `+{{#each navigation}}+`) as well as partials (e.g., `+{{> header}}+`). Gulp (script file: [.path]_gulpfile.js/index.js_):: -{uri-gulp}[Gulp] is a build tool for JavaScript projects. +{url-gulp}[Gulp] is a build tool for JavaScript projects. It configures a collection of tasks that can be used to perform automated tasks such as compiling files, running a preview server, or publishing a release. npm (command: `npm`):: -npm manages software packages (i.e., software dependencies) that it downloads from {uri-npm}. +npm manages software packages (i.e., software dependencies) that it downloads from {url-npm}. Software this project uses includes libraries that handle compilation as well as shared assets such as font files that are distributed as npm packages. npm is part of Node.js. diff --git a/docs/modules/ROOT/pages/prerequisites.adoc b/docs/modules/ROOT/pages/prerequisites.adoc index 5a7b2de..0b6571b 100644 --- a/docs/modules/ROOT/pages/prerequisites.adoc +++ b/docs/modules/ROOT/pages/prerequisites.adoc @@ -1,8 +1,5 @@ = UI Development Prerequisites -// Settings: -:idprefix: -:idseparator: - -// URIs: +// URLs: :url-nvm: https://github.com/creationix/nvm :url-node: https://nodejs.org :url-gulp: http://gulpjs.com diff --git a/docs/modules/ROOT/pages/set-up-project.adoc b/docs/modules/ROOT/pages/set-up-project.adoc index b0ce8a1..be7dac2 100644 --- a/docs/modules/ROOT/pages/set-up-project.adoc +++ b/docs/modules/ROOT/pages/set-up-project.adoc @@ -1,19 +1,15 @@ = Set up a UI Project -// Settings: -:idprefix: -:idseparator: - -// URIs: -:uri-project: https://gitlab.com/antora/antora-ui-default.git +:url-project: https://gitlab.com/antora/antora-ui-default.git Before you can start working on the UI, you need to grab the sources and initialize the project. -The sources can be {uri-project}[Antora's default UI] or an existing UI project structured to work with Antora. +The sources can be {url-project}[Antora's default UI] or an existing UI project structured to work with Antora. == Fetch the Default UI project To start, clone the default UI project using git: [subs=attributes+] - $ git clone {uri-project} && + $ git clone {url-project} && cd "`basename $_`" The example above clones Antora's default UI project and then switches to the project folder on your filesystem. diff --git a/docs/modules/ROOT/pages/stylesheets.adoc b/docs/modules/ROOT/pages/stylesheets.adoc index 9e7d3fe..aff5316 100644 --- a/docs/modules/ROOT/pages/stylesheets.adoc +++ b/docs/modules/ROOT/pages/stylesheets.adoc @@ -1,7 +1,4 @@ = Work with the CSS Stylesheets -// Settings: -:idprefix: -:idseparator: - The stylesheets are written in CSS. These stylesheets utilize CSS variables to keep the CSS DRY and easy to customize. diff --git a/docs/modules/ROOT/pages/templates.adoc b/docs/modules/ROOT/pages/templates.adoc index ebe2233..39a259b 100644 --- a/docs/modules/ROOT/pages/templates.adoc +++ b/docs/modules/ROOT/pages/templates.adoc @@ -1,7 +1,4 @@ = Work with the Handlebars Templates -// Settings: -:idprefix: -:idseparator: - Antora combines the Handlebars templates with the converted AsciiDoc content and other UI model data to make the pages in the site. These "`logic-less`" templates are mostly HTML with some special mustache tags sprinkled in where content should be inserted.