Skip to content
Permalink
Browse files
initial Antora ui for Aries
  • Loading branch information
djencks committed Aug 8, 2020
0 parents commit 62b325be6b17d1aee6107ecd52a1dd09e04203f1
Showing 15 changed files with 210 additions and 0 deletions.
@@ -0,0 +1,14 @@
{
"extends": "standard",
"rules": {
"arrow-parens": ["error", "always"],
"comma-dangle": ["error", {
"arrays": "always-multiline",
"objects": "always-multiline",
"imports": "always-multiline",
"exports": "always-multiline"
}],
"max-len": [1, 120, 2],
"spaced-comment": "off"
}
}
@@ -0,0 +1,4 @@
build
node_modules
public
work
@@ -0,0 +1,32 @@
image: node:10.20.1-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@djencks/aries-antora-ui
cache: *pull_cache
script:
- *npm_install
- node_modules/.bin/gulp bundle
- yarn pack
artifacts:
paths:
- aries-antora-aries-antora-ui-v*.tgz
- build/aries-antora-ui-ui-bundle.zip
@@ -0,0 +1,7 @@
{
"extends": "stylelint-config-standard",
"rules": {
"comment-empty-line-before": null,
"no-descending-specificity": null,
}
}
@@ -0,0 +1,41 @@
= {extension}-ui ui bundle extension
:extension: aries-antora-ui
:extension-version: 0.0.1

== Description

This ui bundle extension...

== Usage

To build a ui bundle based on the antora-ui-default sources with the additions from this extension, run `gulp`.

To combine the UI elements from this extension with other elements, using `@djencks/antora-ui-builder`, include in your antora-ui.yml a clause such as:

[source,yml,subs="+attributes]
---
sources:
- path: antora-ui-default #replace or extend as needed
- path: @djencks/{extension}-ui
---

Set up your UI project as a ui builder project and include in the `package.json`

[source,json,subs="+attributes"]
---
{
"name": "...",
"version": "...",
"description": "...",
"main": "gulpfile.js",
"files": [
"src/**/*",
"build/**/*"
],
"devDependencies": {
"@djencks/antora-ui-builder": "https://experimental-repo.s3-us-west-1.amazonaws.com/djencks-antora-ui-builder-v0.0.1.tgz",
"antora-ui-default": "git+https://gitlab.com/djencks/antora-ui-default.git#issue-126-requireable",
"@djencks/{extension}-ui": "https://experimental-repo.s3-us-west-1.amazonaws.com/djencks-{extension}-ui-v{extension-version}.tgz"
}
}
---
@@ -0,0 +1,4 @@
sources:
- path: '@antora/antora-ui-default'
- path: ./
bundle-name: aries-antora-ui
Binary file not shown.
@@ -0,0 +1,17 @@
'use strict'

const builder = require('@djencks/antora-ui-builder')

module.exports = builder
// module.exports = exportTasks(
// bundleTask,
// cleanTask,
// lintTask,
// formatTask,
// buildTask,
// bundleTask,
// bundlePackTask,
// previewTask,
// previewBuildTask,
// packTask
// )
@@ -0,0 +1,14 @@
{
"name": "@apache-aries/aries-antora-ui",
"version": "0.0.1",
"description": "Apache aries antora ui contents",
"main": "gulpfile.js",
"files": [
"src/**/*",
"build/**/*"
],
"devDependencies": {
"@djencks/antora-ui-builder": "https://experimental-repo.s3-us-west-1.amazonaws.com/djencks-antora-ui-builder-v0.0.1.tgz",
"@antora/antora-ui-default": "git+https://gitlab.com/antora/antora-ui-default.git"
}
}
@@ -0,0 +1,10 @@
:root {
/* colors */
/* navbar */
--navbar-background: var(--color-smoke-70);
--navbar_hover-background: var(--color-smoke-90);
--navbar-font-color: var(--color-gray-50);
--navbar-height: calc(108 / var(--rem-base) * 1rem);
/* footer */
--footer-background: var(--color-smoke-70);
}
@@ -0,0 +1,18 @@
@import "typeface-roboto.css";
@import "typeface-roboto-mono.css";
@import "vars.css";
@import "aries-vars.css";
@import "base.css";
@import "body.css";
@import "nav.css";
@import "main.css";
@import "toolbar.css";
@import "breadcrumbs.css";
@import "page-versions.css";
@import "toc.css";
@import "doc.css";
@import "pagination.css";
@import "header.css";
@import "footer.css";
@import "highlight.css";
@import "print.css";
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
BIN +1.94 KB src/img/feather.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
@@ -0,0 +1,5 @@
<footer class="footer">
<p>The UI for this page extends the Antora default UI.</p>
<p>The source code for the Antora default UI is licensed under the terms of the MPL-2.0 license.</p>
<p>Extensions and content are licensed under AL2</p>
</footer>
@@ -0,0 +1,44 @@
<header class="header">
<nav class="navbar">
<div class="navbar-brand">
<a class="navbar-item" href="{{{or site.url (or siteRootUrl siteRootPath)}}}/index.html">
<span>
<img src="{{siteRootPath}}/_/img/feather.png">
</span>
<span>
<img src="{{siteRootPath}}/_/img/Arieslogo_Horizontal.gif">
</span>
{{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="#">Projects</a>
<div class="navbar-dropdown">
<a class="navbar-item" href="{{{relativize "/documentation/modules/async-svcs.html"}}}">Async Services</a>
<a class="navbar-item" href="{{{relativize "/documentation/modules/blueprint.html"}}}">Blueprint</a>
<a class="navbar-item" href="{{{relativize "/documentation/modules/jmx.html"}}}">JMX</a>
<a class="navbar-item" href="{{{relativize "/documentation/modules/jndiproject.html"}}}">JNDI</a>
<a class="navbar-item" href="{{{relativize "/documentation/modules/jpaproject.html"}}}">JPA</a>
<a class="navbar-item" href="{{{relativize "/documentation/modules/rsa.html"}}}">Remote Service Admin</a>
<a class="navbar-item" href="{{{relativize "/documentation/modules/spi-fly.html"}}}">Spi-Fly</a>
<a class="navbar-item" href="{{{relativize "/documentation/modules/subsystems.html"}}}">Subsystems</a>
<a class="navbar-item" href="{{{relativize "/documentation/modules/transactioncontrol.html"}}}">Transaction Control</a>
</div>
</div>
<div class="navbar-item">
<span class="control">
<a class="button is-primary" href="{{{relativize "/documentation/downloads/currentreleases.html"}}}">Downloads</a>
</span>
</div>
</div>
</div>
</nav>
</header>

0 comments on commit 62b325b

Please sign in to comment.