You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by dj...@apache.org on 2021/07/11 23:06:42 UTC
[felix-antora-ui] 01/02: initial felix antora ui commit
This is an automated email from the ASF dual-hosted git repository.
djencks pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/felix-antora-ui.git
commit 00065b503d99fd6a1faa3af5607fc81fbf787360
Author: David Jencks <dj...@apache.org>
AuthorDate: Tue Sep 1 11:13:21 2020 -0700
initial felix antora ui commit
---
.eslintrc | 14 +++++++++++++
.gitignore | 4 ++++
.gitlab-ci.yml | 32 ++++++++++++++++++++++++++++++
.stylelintrc | 7 +++++++
README.adoc | 41 +++++++++++++++++++++++++++++++++++++++
antora-ui.yml | 4 ++++
build/felix-antora-ui-bundle.zip | Bin 0 -> 272293 bytes
gulpfile.js | 17 ++++++++++++++++
package.json | 14 +++++++++++++
9 files changed, 133 insertions(+)
diff --git a/.eslintrc b/.eslintrc
new file mode 100644
index 0000000..fc50489
--- /dev/null
+++ b/.eslintrc
@@ -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"
+ }
+}
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..977d53a
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,4 @@
+build
+node_modules
+public
+work
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
new file mode 100644
index 0000000..17b986d
--- /dev/null
+++ b/.gitlab-ci.yml
@@ -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@felix/antora-felix-antora
+ cache: *pull_cache
+ script:
+ - *npm_install
+ - node_modules/.bin/gulp bundle
+ - yarn pack
+ artifacts:
+ paths:
+ - felix-antora-felix-antora-v*.tgz
+ - build/felix-antora-ui-bundle.zip
diff --git a/.stylelintrc b/.stylelintrc
new file mode 100644
index 0000000..344318f
--- /dev/null
+++ b/.stylelintrc
@@ -0,0 +1,7 @@
+{
+ "extends": "stylelint-config-standard",
+ "rules": {
+ "comment-empty-line-before": null,
+ "no-descending-specificity": null,
+ }
+}
diff --git a/README.adoc b/README.adoc
new file mode 100644
index 0000000..e10d159
--- /dev/null
+++ b/README.adoc
@@ -0,0 +1,41 @@
+= {extension}-ui ui bundle extension
+:extension: felix-antora
+: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"
+ }
+}
+---
diff --git a/antora-ui.yml b/antora-ui.yml
new file mode 100644
index 0000000..4f356af
--- /dev/null
+++ b/antora-ui.yml
@@ -0,0 +1,4 @@
+sources:
+ - path: '@antora/antora-ui-default'
+ - path: ./
+bundle-name: felix-antora-ui
diff --git a/build/felix-antora-ui-bundle.zip b/build/felix-antora-ui-bundle.zip
new file mode 100644
index 0000000..c3f4362
Binary files /dev/null and b/build/felix-antora-ui-bundle.zip differ
diff --git a/gulpfile.js b/gulpfile.js
new file mode 100644
index 0000000..ef34229
--- /dev/null
+++ b/gulpfile.js
@@ -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
+// )
diff --git a/package.json b/package.json
new file mode 100644
index 0000000..f584e22
--- /dev/null
+++ b/package.json
@@ -0,0 +1,14 @@
+{
+ "name": "@djencks/felix-antora-ui",
+ "version": "0.0.1",
+ "description": "felix-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"
+ }
+}