docs: UI includes branches

.gitattributes

@@ -1,2 +1,3 @@
 test-files/**/*.xml binary
 test-files/golden-tests/** text eol=lf
+**.sh text eol=lf

.github/workflows/ci.yml

@@ -611,6 +611,18 @@ jobs:
           cp index.html ../../build/website/index.html
           cp styles.css ../../build/website/styles.css
 
+      - name: Generate Antora UI
+        working-directory: docs/ui
+        run: |
+          # This playbook renders the documentation 
+          # content for the website. It includes
+          # master, develop, and tags.
+          GH_TOKEN="${{ secrets.GITHUB_TOKEN }}"
+          export GH_TOKEN
+          npm ci
+          npx gulp lint
+          npx gulp
+
       - name: Generate Remote Documentation
         working-directory: docs
         run: |

.gitignore

@@ -10,5 +10,8 @@
 /test-files/**/*.bad.xml
 docs/node_modules
 docs/build
+docs/ui/node_modules
+docs/ui/build
+docs/ui/public
 share/mrdocs/libcxx/
 share/mrdocs/clang/

docs/antora-playbook.yml

@@ -25,7 +25,7 @@ content:
 
 ui:
   bundle:
-    url: 'https://github.com/boostorg/website-v2-docs/releases/download/ui-develop/ui-bundle.zip'
+    url: './ui/build/ui-bundle.zip'
     snapshot: true
 
 antora:

docs/build_docs.sh

@@ -8,6 +8,16 @@
 # Official repository: https://github.com/cppalliance/mrdocs
 #
 
+echo "Building documentation UI"
+cwd=$(pwd)
+script_dir=$(dirname "$(readlink -f "$0")")
+if ! [ -e "$script_dir/ui/build/ui-bundle.zip" ]; then
+  echo "Building antora-ui"
+  cd "$script_dir/ui" || exit
+  ./build.sh
+  cd "$cwd" || exit
+fi
+
 echo "Building documentation with Antora..."
 echo "Installing npm dependencies..."
 npm ci

docs/build_local_docs.sh

@@ -8,6 +8,16 @@
 # Official repository: https://github.com/cppalliance/mrdocs
 #
 
+echo "Building documentation UI"
+cwd=$(pwd)
+script_dir=$(dirname "$(readlink -f "$0")")
+if ! [ -e "$script_dir/ui/build/ui-bundle.zip" ]; then
+  echo "Building antora-ui"
+  cd "$script_dir/ui" || exit
+  ./build.sh
+  cd "$cwd" || exit
+fi
+
 echo "Building documentation with Antora..."
 echo "Installing npm dependencies..."
 npm ci

docs/ui/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

docs/ui/.eslintrc

@@ -0,0 +1,19 @@
+{
+  "extends": "standard",
+  "rules": {
+    "arrow-parens": ["error", "always"],
+    "comma-dangle": ["error", {
+      "arrays": "always-multiline",
+      "objects": "always-multiline",
+      "imports": "always-multiline",
+      "exports": "always-multiline"
+    }],
+    "no-restricted-properties": ["error", {
+      "property": "substr",
+      "message": "Use String#slice instead."
+    }],
+    "max-len": [1, 120, 2],
+    "spaced-comment": "off",
+    "radix": ["error", "always"]
+  }
+}

docs/ui/.gitignore

@@ -0,0 +1,3 @@
+/build/
+/node_modules/
+/public/

docs/ui/.gitlab-ci.yml

@@ -0,0 +1,55 @@
+image: node:10.14.2-stretch
+stages: [setup, verify, deploy]
+install:
+  stage: setup
+  cache:
+    paths:
+    - .cache/npm
+  script:
+  - &npm_install
+    npm install --quiet --no-progress --cache=.cache/npm
+lint:
+  stage: verify
+  cache: &pull_cache
+    policy: pull
+    paths:
+    - .cache/npm
+  script:
+  - *npm_install
+  - node_modules/.bin/gulp lint
+bundle-stable:
+  stage: deploy
+  only:
+  - master@antora/antora-ui-default
+  cache: *pull_cache
+  script:
+  - *npm_install
+  - node_modules/.bin/gulp bundle
+  artifacts:
+    paths:
+    - build/ui-bundle.zip
+bundle-dev:
+  stage: deploy
+  except:
+  - master
+  cache: *pull_cache
+  script:
+  - *npm_install
+  - node_modules/.bin/gulp bundle
+  artifacts:
+    expire_in: 1 day # unless marked as keep from job page
+    paths:
+    - build/ui-bundle.zip
+pages:
+  stage: deploy
+  only:
+  - master@antora/antora-ui-default
+  cache: *pull_cache
+  script:
+  - *npm_install
+  - node_modules/.bin/gulp preview:build
+  # FIXME figure out a way to avoid copying these files to preview site
+  - rm -rf public/_/{helpers,layouts,partials}
+  artifacts:
+    paths:
+    - public

docs/ui/.gulp.json

@@ -0,0 +1,4 @@
+{
+  "description": "Build tasks for the Antora default UI project",
+  "flags.tasksDepth": 1
+}

docs/ui/.nvmrc

@@ -0,0 +1 @@
+10

docs/ui/.stylelintrc

@@ -0,0 +1,7 @@
+{
+  "extends": "stylelint-config-standard",
+  "rules": {
+    "comment-empty-line-before": null,
+    "no-descending-specificity": null,
+  }
+}