https://github.com/payara/antora-ui-default

https://github.com/payara/antora-ui-default

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/payara/antora-ui-default
• Owner: payara
• License: mpl-2.0
• Created: 2020-04-22T09:35:39.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-03-15T15:17:28.000Z (10 months ago)
• Last Synced: 2024-03-15T16:38:44.214Z (10 months ago)
• Language: CSS
• Size: 3.5 MB
• Stars: 1
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

        
= Payara Documentation UI

// Settings:

:experimental:

:hide-uri-scheme:

// Project URLs:

:url-project: https://gitlab.com/antora/antora-ui-default

:url-preview: https://antora.gitlab.io/antora-ui-default

:url-ci-pipelines: {url-project}/pipelines

:img-ci-status: {url-project}/badges/master/pipeline.svg

// External URLs:

:url-antora: https://antora.org

:url-payara-docs: https://docs.payara.fish

:url-antora-docs: https://docs.antora.org

:url-git: https://git-scm.com

:url-git-dl: {url-git}/downloads

:url-gulp: http://gulpjs.com

:url-opendevise: https://opendevise.com

:url-nodejs: https://nodejs.org

:url-nvm: https://github.com/creationix/nvm

:url-nvm-install: {url-nvm}#installation

:url-source-maps: https://developer.mozilla.org/en-US/docs/Tools/Debugger/How_to/Use_a_source_map

This project is the source code and also a repository for the UI bundle that is used by {url-antora}[Antora] for both Payara Documentation editions to generate the {url-payara-docs}[Payara Platform and Cloud Documentation site].

The UI is based on the {url-project}[default Antora UI].

== Configuration Attributes

The UI has been customized to render and configure some elements based on the edition of the site being generated (whether for Payara Enterprise/Community or Payara Cloud). To this effect the following https://docs.antora.org/antora/latest/page/page-attributes/#custom-attribute[page attributes] are used:

`page-site-edition`::

The edition that corresponds to the documentation site.

One of:

* `enterprise`

* `community`

* `cloud`

== Copyright and License

This code is based on the {url-project}[default Antora UI].

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.