Skip to content
Permalink
Browse files
Uses antora supplemental_files to customize UI
Antora supplemental_files are not well documented but they allow to
override the UI templates from the UI bundle, not that this mecanisme
DOES NOT allow properly overriding UI style, only content and HTML
structure.
  • Loading branch information
jeantil authored and chibenwa committed Apr 7, 2021
1 parent acf47a2 commit 7d5b1c9101fc4c3bed9eb408185cf43cac983fda
Showing 5 changed files with 114 additions and 63 deletions.
@@ -4,8 +4,12 @@
# Ignore Gradle build output directory
build


# Ignore antora cache directorry
doc-sites/.cache

.vscode
.project

node_modules
target
target
@@ -8,33 +8,15 @@ site:
start_page: james-site::homepage.adoc
content:
sources:
- url: ./../../james-hupa
branches: HEAD
start_path: docs
- url: ./../../james-jdkim
branches: HEAD
start_path: docs
- url: ./../../james-jsieve
branches: HEAD
start_path: docs
- url: ./../../james-jspf
branches: HEAD
start_path: docs
- url: ./../../james-mime4j
branches: HEAD
start_path: docs
- url: ./../../james-project
branches: HEAD
start_path: docs
- url: ./../../james-postage
branches: HEAD
start_path: docs
- url: ./../
branches: HEAD
start_path: docs
- url: ./../../james-project
branches: HEAD
start_path: docs
- url: ./../
branches: HEAD
start_path: docs
ui:
bundle:
url: ./../antora-ui/build/ui-bundle.zip
# start_path: ui-bundle
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
supplemental_files: ./ui-overrides
runtime:
fetch: true
@@ -1,44 +1,21 @@
runtime:
cache_dir: ./.cache/antora
fetch: true
site:
title: Apache James
url: https://james.apache.org/
start_page: james-site::homepage.adoc
content:
sources:
- url: https://github.com/apache/james-hupa.git
branches: master
start_path: docs
edit_url: '{web_url}/blob/{refname}/{path}'
- url: https://github.com/apache/james-jdkim.git
branches: master
start_path: docs
edit_url: '{web_url}/blob/{refname}/{path}'
- url: https://github.com/apache/james-jsieve.git
branches: master
start_path: docs
edit_url: '{web_url}/blob/{refname}/{path}'
- url: https://github.com/apache/james-jspf.git
branches: master
start_path: docs
edit_url: '{web_url}/blob/{refname}/{path}'
- url: https://github.com/apache/james-mime4j.git
branches: master
start_path: docs
edit_url: '{web_url}/blob/{refname}/{path}'
- url: https://github.com/apache/james-project.git
branches: master
start_path: docs
edit_url: '{web_url}/blob/{refname}/{path}'
- url: https://github.com/apache/james-postage.git
branches: master
start_path: docs
edit_url: '{web_url}/blob/{refname}/{path}'
- url: ./../
branches: HEAD
start_path: docs
edit_url: '{web_url}/blob/{refname}/{path}'
- url: https://github.com/apache/james-project.git
branches: master
start_path: docs
edit_url: "{web_url}/blob/{refname}/{path}"
- url: ./../
branches: HEAD
start_path: docs
edit_url: "{web_url}/blob/{refname}/{path}"
ui:
bundle:
url: ./../antora-ui/build/ui-bundle.zip
# start_path: ui-bundle
runtime:
fetch: true
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
supplemental_files: ./ui-overrides
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
@@ -0,0 +1,52 @@
<header class="header">
<nav class="navbar">
<div class="navbar-brand">
<a class="navbar-item" href="{{{or site.url (or siteRootUrl siteRootPath)}}}"><img src="/_/img/james.svg" alt="james logo"> {{site.title}}</a>
<button class="navbar-burger" data-target="topbar-nav">
<span></span>
<span></span>
<span></span>
</button>
</div>
<div id="topbar-nav" class="navbar-menu">
<div class="navbar-end">
<a class="navbar-item" href="#">Home</a>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Products</a>
<div class="navbar-dropdown">
<div class="navbar-item"><strong>James server</strong></div>
<a class="navbar-item" href="https://github.com/apache/james-project">Repository</a>
<a class="navbar-item" href="https://issues.apache.org/jira/projects/JAMES/issues">Issue Tracker</a>
<hr class="navbar-divider">
<a class="navbar-item" href="https://james.apache.org/mime4j/index.html">Mime4J</a>
<a class="navbar-item" href="https://james.apache.org/jsieve/index.html">jSieve</a>
<a class="navbar-item" href="https://james.apache.org/jspf/index.html">jSPF</a>
<a class="navbar-item" href="https://james.apache.org/jdkim/index.html">jDKIM</a>
<a class="navbar-item" href="https://james.apache.org/hupa/index.html">HUPA</a>
</div>
</div>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Community</a>
<div class="navbar-dropdown">
<!-- Not ideal but dropping the version in the href requires tweaking james-projet docs module first -->
<a class="navbar-item" href="/james-project/3.6.0/community/mailing-lists.html">Mailing lists</a>
<a class="navbar-item" href="https://gitter.im/apache/james-project"><svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 32 32" class="logo-gitter-sign" data-v-44ebcb1a=""><rect x="15" y="5" width="2" height="10"></rect> <rect x="10" y="5" width="2" height="20"></rect> <rect x="5" y="5" width="2" height="20"></rect> <rect width="2" height="15"></rect></svg> Gitter</a>
<a class="navbar-item" href="https://twitter.com/ApacheJames">
<span class="icon">
<svg aria-hidden="true" data-icon="twitter" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">
<path fill="#57aaee" d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"></path>
</svg>
</span> Twitter
</a>
<a class="navbar-item" href="#"> <svg class="octicon octicon-mark-github v-align-middle" viewBox="0 0 16 16" version="1.1" aria-hidden="true"><path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"></path></svg> Github</a>
</div>
</div>
<!-- <div class="navbar-item">
<span class="control">
<a class="button is-primary" href="#">Download</a>
</span>
</div> -->
</div>
</div>
</nav>
</header>

0 comments on commit 7d5b1c9

Please sign in to comment.