Permalink
Show file tree
Hide file tree
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
9 changed files
with
133 additions
and
0 deletions.
There are no files selected for viewing
14
.eslintrc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
build | ||
node_modules | ||
public | ||
work |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"extends": "stylelint-config-standard", | ||
"rules": { | ||
"comment-empty-line-before": null, | ||
"no-descending-specificity": null, | ||
} | ||
} |
41
README.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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" | ||
} | ||
} | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
sources: | ||
- path: '@antora/antora-ui-default' | ||
- path: ./ | ||
bundle-name: felix-antora-ui |
BIN
+266 KB
build/felix-antora-ui-bundle.zip
Binary file not shown.
17
gulpfile.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
// ) |
14
package.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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" | ||
} | ||
} |