Skip to content

Commit 9c15ed5

Browse files
KenniMeric-schneiderjgillenwater
authored
Merge feature/new-helios-base into main (#27)
* New Gulp bundler and new Antora version added * removed /releases folder from gcx * Update README.adoc * Update README.adoc Instructions to use Helios Gulp bundler * Update README.adoc * Update README and clean Helios build folder * Update README.adoc * Update README.adoc * Fixes in PrismJS theme * Helios CSS Modules Some of Helios styles have been split into additional files to facilitate the management of these * Rebuild feedback * The color scheme for GCX has been updated to match Helios and some minor fixes in prism theming. * The header should now show correctly as the live site shows. * Content links in right sidebar should now take to the propiate place when clicking them * Fixed Dependabot dependencies issues * Using temporary branch to merge new-helios-base with main (#33) * change landing page icon directory name * Google Tag Manager (#31) Co-authored-by: Jamie Gillenwater <> Co-authored-by: Eric Schneider <[email protected]> Co-authored-by: Jamie Gillenwater <[email protected]> Co-authored-by: Eric Schneider <[email protected]> Co-authored-by: Jamie Gillenwater <[email protected]>
1 parent 4644227 commit 9c15ed5

File tree

359 files changed

+88371
-9860
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

359 files changed

+88371
-9860
lines changed

‎.editorconfig‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
end_of_line = lf
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true

‎.github/CODEOWNERS‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎.gitignore‎

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,4 @@
1-
node_modules
2-
public
3-
.vscode
4-
build
5-
.DS_Store
6-
*~
1+
build/
2+
node_modules/
3+
public/
74

8-
.stylelintrc
9-
gulpfile.js
10-
package-lock.json
11-
package.json

‎.gitlab-ci.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
image: node:10.14.2-stretch
2+
stages: [setup, verify, deploy]
3+
install:
4+
stage: setup
5+
cache:
6+
paths:
7+
- .cache/npm
8+
script:
9+
- &npm_install
10+
npm install --quiet --no-progress --cache=.cache/npm
11+
lint:
12+
stage: verify
13+
cache: &pull_cache
14+
policy: pull
15+
paths:
16+
- .cache/npm
17+
script:
18+
- *npm_install
19+
- node_modules/.bin/gulp lint
20+
bundle-stable:
21+
stage: deploy
22+
only:
23+
- master@antora/antora-ui-default
24+
cache: *pull_cache
25+
script:
26+
- *npm_install
27+
- node_modules/.bin/gulp bundle
28+
artifacts:
29+
paths:
30+
- build/ui-bundle.zip
31+
bundle-dev:
32+
stage: deploy
33+
except:
34+
- master
35+
cache: *pull_cache
36+
script:
37+
- *npm_install
38+
- node_modules/.bin/gulp bundle
39+
artifacts:
40+
expire_in: 1 day # unless marked as keep from job page
41+
paths:
42+
- build/ui-bundle.zip
43+
pages:
44+
stage: deploy
45+
only:
46+
- master@antora/antora-ui-default
47+
cache: *pull_cache
48+
script:
49+
- *npm_install
50+
- node_modules/.bin/gulp preview:build
51+
# FIXME figure out a way to avoid copying these files to preview site
52+
- rm -rf public/_/{helpers,layouts,partials}
53+
artifacts:
54+
paths:
55+
- public

‎.gulp.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"description": "Build tasks for the Antora default UI project",
3+
"flags.tasksDepth": 1
4+
}

‎.nvmrc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
10

‎.stylelintrc‎

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
11
{
2-
"extends": "stylelint-config-standard",
3-
"rules": {
4-
"comment-empty-line-before": null,
5-
"no-descending-specificity": null,
6-
"selector-type-no-unknown": null
7-
},
8-
"ignore": [
9-
"custom-elements",
10-
"default-namespace"
11-
]
12-
}
2+
"extends": "stylelint-config-standard",
3+
"rules": {
4+
"comment-empty-line-before": null,
5+
"no-descending-specificity": null,
6+
}
7+
}

‎README.adoc‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,27 @@ gulp bundle:pack
274274

275275
The UI bundle will again be available at [.path]_build/ui-bundle.zip_.
276276

277+
=== Package for use with Antora adding Helios GCX
278+
279+
To include Helios GCX to the Antora bundle, you can build it following these steps:
280+
281+
Install the Node dependencies from the `./gcx` folder:
282+
283+
[source,shell]
284+
----
285+
cd ./gcx
286+
npm install
287+
----
288+
289+
Once it finished, you can run on this folder:
290+
291+
[source,shell]
292+
----
293+
npm run bundle
294+
----
295+
296+
This script will run both Antora and Helios bundlers, the final build you can find it on `./gcx/build` as `ui-bundle.zip`
297+
277298
==== Source maps
278299

279300
The build consolidates all the CSS and client-side JavaScript into combined files, [.path]_site.css_ and [.path]_site.js_, respectively, in order to reduce the size of the bundle.
@@ -340,4 +361,4 @@ Use of this software is granted under the terms of the https://www.mozilla.org/e
340361
=== Branding and design
341362

342363
Copyright (C) {url-datastax}[DataStax] 2021-present.
343-
All rights reserved.
364+
All rights reserved.

‎docs/antora.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
name: antora-ui-default
2+
title: Antora Default UI
3+
version: ~
4+
nav:
5+
- modules/ROOT/nav.adoc

‎docs/modules/ROOT/nav.adoc‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
* xref:prerequisites.adoc[]
2+
* xref:set-up-project.adoc[]
3+
* xref:build-preview-ui.adoc[]
4+
* xref:development-workflow.adoc[]
5+
* xref:templates.adoc[]
6+
** xref:create-helper.adoc[]
7+
* xref:add-static-files.adoc[]
8+
* xref:stylesheets.adoc[]
9+
** xref:add-fonts.adoc[]
10+
* xref:copy-to-clipboard.adoc[]
11+
* xref:style-guide.adoc[]
12+
** xref:inline-text-styles.adoc[]
13+
** xref:admonition-styles.adoc[]
14+
** xref:list-styles.adoc[]
15+
** xref:sidebar-styles.adoc[]
16+
** xref:ui-macro-styles.adoc[]

0 commit comments

Comments
 (0)