Rebase Spring 0.4.16

README.md

@@ -0,0 +1,113 @@
+
+<p align="center">
+  <a href="https://micrometer.io/">
+    <img alt="Micrometer" src="https://micrometer.io/img/logo-no-title.svg" width="250" />
+  </a>
+</p>
+
+[![On Push](https://github.com/micrometer-metrics/antora-ui-micrometer/actions/workflows/push.yml/badge.svg?branch=main)](https://github.com/micrometer-metrics/antora-ui-micrometer/actions/workflows/push.yml)
+
+
+This project generates and packages the static resources that Spring uses for document production.
+
+This project is based on [Antora](https://antora.org).
+
+
+## Development Quickstart
+
+This section offers a basic tutorial to teach you how to preview it locally, and bundle it for use with Antora.
+A more comprehensive tutorial can be found in the documentation at [docs.antora.org](https://docs.antora.org/).
+
+### Prerequisites
+
+To preview and bundle the Antora Spring UI, you need the following software on your computer:
+
+* [git](https://git-scm.com/) (command: `git`)
+* [Node.js](https://nodejs.org/) (commands: `node` and `npm`)
+* [Gulp CLI](http://gulpjs.com/) (command: `gulp`)
+
+### Preview the UI
+
+The Spring Antora UI project is configured to preview offline.
+The files in the `preview-src/` folder provide the sample content that allow you to see the UI in action.
+In this folder, you'll primarily find pages written in AsciiDoc.
+These pages provide a representative sample and kitchen sink of content from the real site.
+
+To build the UI and preview it in a local web server, run the `preview` command:
+
+```
+npm install
+gulp preview
+```
+
+You'll see a URL listed in the output of this command:
+
+```
+[12:00:00] Starting server...
+[12:00:00] Server started http://localhost:5252
+[12:00:00] Running server
+```
+
+Navigate to this URL to preview the site locally.
+
+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 `preview:build` task if a change is detected, and sending the updates to the browser.
+
+Press `Ctrl`+`C` to stop the preview server and end the continuous build.
+
+### Package for Use with Antora
+
+If you need to package the UI so you can use it to generate the documentation site locally, run the following command:
+
+```
+gulp bundle
+```
+
+If any errors are reported by lint, you'll need to fix them.
+
+When the command completes successfully, the UI bundle will be available at `build/ui-bundle.zip`.
+You can 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 `build/ui-bundle.zip`.
+
+## Extensions to the UI
+
+### Related Documentation
+
+The UI presents a list of related documentation and that documentation can be filtered using two attributes:
+
+* page-related-doc-categories - The categories to be included in the related documentation
+* page-related-doc-projects - The project ids to be included in the related documentation
+
+For a complete listing of valid categories and ids view [related_projects.js](https://github.com/spring-io/antora-ui-spring/blob/main/src/helpers/related_projects.js)
+
+The configuration is typically specified in asciidoc attributes section of the `antora-playbook.yml`:
+
+```
+asciidoc:
+  attributes:
+    # Include the projects with the security category
+    page-related-doc-categories: security
+    # Include the projects with ids framework and graphql
+    page-related-doc-projects: framework,graphql
+```
+
+The Related Documentation links to the `All Docs...` page.
+To include this resource, ensure that the [antora-extensions](https://github.com/spring-io/antora-extensions/blob/main/README.adoc) is using 1.7.0+ and the [Static Page Extension](https://github.com/spring-io/antora-extensions/blob/main/README.adoc#static-page) is included.
+
+## Authors
+
+Development of Antora is led and sponsored by [OpenDevise Inc](https://opendevise.com/).
+
+## Copyright and License
+
+Copyright (C) 2017-present OpenDevise Inc. and the Antora Project.
+
+Use of this software is granted under the terms of the [Mozilla Public License Version 2.0](https://www.mozilla.org/en-US/MPL/2.0/) (MPL-2.0).
+See [LICENSE](https://github.com/spring-io/antora-ui-spring/blob/feat/gh-226/LICENSE) to find the full license text.

gulp.d/tasks/build.js

@@ -17,9 +17,11 @@ const postcssUrl = require('postcss-url')
 const postcssVar = require('postcss-custom-properties')
 const { Transform } = require('stream')
 const map = (transform) => new Transform({ objectMode: true, transform })
+const replace = require('gulp-replace')
 const through = () => map((file, enc, next) => next(null, file))
 const uglify = require('gulp-uglify')
 const vfs = require('vinyl-fs')
+const git = require('git-rev-sync')
 
 module.exports = (src, dest, preview) => () => {
   const opts = { base: src, cwd: src }
@@ -100,7 +102,7 @@ module.exports = (src, dest, preview) => () => {
     ),
     vfs.src('helpers/*.js', opts),
     vfs.src('layouts/*.hbs', opts),
-    vfs.src('partials/*.hbs', opts)
+    vfs.src('partials/*.hbs', opts).pipe(replace('@@antora-ui-version', git.isTagDirty() ? git.long() : git.tag()))
   ).pipe(vfs.dest(dest, { sourcemaps: sourcemaps && '.' }))
 }
 

gulp.d/tasks/generate-octicons.js

@@ -16,6 +16,7 @@ const icons = [
   'info',
   'law',
   'light-bulb',
+  'link-external',
   'moon',
   'question',
   'rocket',