Skip to content
BranchesTags

Repository files navigation

Antora Default UI Customized

This is forked version of the antora default ui.

Enhancements that have been made to the original are:

  • light/dark mode and theme switcher button

  • github highlightjs styles for light/dark modes

  • source code tabs

  • styled admonition blocks with icons

  • font-awesome 4 (font and css)

  • widens main content panel by percentages #10

  • replace Roboto font with system font #11

Release

See releases for publish versions of the ui-bundle zip.

Development

Original docs for full help.

For a link of all the gulp tasks

$ gulp --tasks-simple

Preview the UI

The default UI project is configured to preview offline. The files in the preview-src/ folder provide the sample content that allow you to see the UI in action. In this folder, you’ll primarily find pages written in AsciiDoc. These pages provide a representative sample and kitchen sink of content from the real site.

To build the UI and preview it in a local web server, run the preview command:

$ gulp preview

You’ll see a URL listed in the output of this command:

[12:00:00] Starting server...
[12:00:00] Server started http://localhost:5252
[12:00:00] Running server

Navigate to this URL to preview the site locally.

While this command is running, any changes you make to the source files will be instantly reflected in the browser. This works by monitoring the project for changes, running the preview:build task if a change is detected, and sending the updates to the browser.

Press kbd:[Ctrl+C] to stop the preview server and end the continuous build.

Package for Use with Antora

If you need to package the UI so you can use it to generate the documentation site locally, run the following command:

$ gulp bundle

If any errors are reported by lint, you’ll need to fix them.

When the command completes successfully, the UI bundle will be available at build/ui-bundle.zip. You can point Antora at this bundle using the --ui-bundle-url command-line option.

If you have the preview running, and you want to bundle without causing the preview to be clobbered, use:

$ gulp bundle:pack

The UI bundle will again be available at build/ui-bundle.zip.

Source Maps

The build consolidates all the CSS and client-side JavaScript into combined files, site.css and site.js, respectively, in order to reduce the size of the bundle. {url-source-maps}[Source maps] correlate these combined files with their original sources.

This “source mapping” is accomplished by generating additional map files that make this association. These map files sit adjacent to the combined files in the build folder. The mapping they provide allows the debugger to present the original source rather than the obfuscated file, an essential tool for debugging.

In preview mode, source maps are enabled automatically, so there’s nothing you have to do to make use of them. If you need to include source maps in the bundle, you can do so by setting the SOURCEMAPS environment variable to true when you run the bundle command:

$ SOURCEMAPS=true gulp bundle

In this case, the bundle will include the source maps, which can be used for debugging your production site.

Merge Upstream

git remote add upstream git@gitlab.com:antora/antora-ui-default.git
git fetch upstream
git checkout master
git merge --no-ff upstream/master

About

Fork of default antora ui.

countableset.github.io/antora-ui/

Resources

Readme
MPL-2.0 license
Activity

Stars

2 stars

Watchers

1 watching

Forks

3 forks
Report repository

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
GitHub - countableSet/antora-ui: Fork of default antora ui. · GitHub
Skip to content
BranchesTags
Repository files navigation
Antora Default UI Customized
This is forked version of the antora default ui.
Enhancements that have been made to the original are:
  • light/dark mode and theme switcher button
  • github highlightjs styles for light/dark modes
  • source code tabs
  • styled admonition blocks with icons
  • font-awesome 4 (font and css)
  • widens main content panel by percentages #10
  • replace Roboto font with system font #11
Release
See releases for publish versions of the ui-bundle zip.
Development
Original docs for full help.
For a link of all the gulp tasks
$ gulp --tasks-simple
Preview the UI
The default UI project is configured to preview offline.
The files in the preview-src/ folder provide the sample content that allow you to see the UI in action.
In this folder, you’ll primarily find pages written in AsciiDoc.
These pages provide a representative sample and kitchen sink of content from the real site.
To build the UI and preview it in a local web server, run the preview command:
$ gulp preview
You’ll see a URL listed in the output of this command:
[12:00:00] Starting server...
[12:00:00] Server started http://localhost:5252
[12:00:00] Running server
Navigate to this URL to preview the site locally.
While this command is running, any changes you make to the source files will be instantly reflected in the browser.
This works by monitoring the project for changes, running the preview:build task if a change is detected, and sending the updates to the browser.
Press kbd:[Ctrl+C] to stop the preview server and end the continuous build.
Package for Use with Antora
If you need to package the UI so you can use it to generate the documentation site locally, run the following command:
$ gulp bundle
If any errors are reported by lint, you’ll need to fix them.
When the command completes successfully, the UI bundle will be available at build/ui-bundle.zip.
You can point Antora at this bundle using the --ui-bundle-url command-line option.
If you have the preview running, and you want to bundle without causing the preview to be clobbered, use:
$ gulp bundle:pack
The UI bundle will again be available at build/ui-bundle.zip.
Source Maps
The build consolidates all the CSS and client-side JavaScript into combined files, site.css and site.js, respectively, in order to reduce the size of the bundle.
{url-source-maps}[Source maps] correlate these combined files with their original sources.
This “source mapping” is accomplished by generating additional map files that make this association.
These map files sit adjacent to the combined files in the build folder.
The mapping they provide allows the debugger to present the original source rather than the obfuscated file, an essential tool for debugging.
In preview mode, source maps are enabled automatically, so there’s nothing you have to do to make use of them.
If you need to include source maps in the bundle, you can do so by setting the SOURCEMAPS environment variable to true when you run the bundle command:
$ SOURCEMAPS=true gulp bundle
In this case, the bundle will include the source maps, which can be used for debugging your production site.
Merge Upstream
git remote add upstream git@gitlab.com:antora/antora-ui-default.git
git fetch upstream
git checkout master
git merge --no-ff upstream/master
About
Fork of default antora ui.
countableset.github.io/antora-ui/
Resources
Readme
MPL-2.0 license
Activity
Stars
2 stars
Watchers
1 watching
Forks
3 forks
Report repository
Releases
Packages
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
GitHub - countableSet/antora-ui: Fork of default antora ui. · GitHub
Skip to content
BranchesTags
Repository files navigation
Antora Default UI Customized
This is forked version of the antora default ui.
Enhancements that have been made to the original are:
  • light/dark mode and theme switcher button
  • github highlightjs styles for light/dark modes
  • source code tabs
  • styled admonition blocks with icons
  • font-awesome 4 (font and css)
  • widens main content panel by percentages #10
  • replace Roboto font with system font #11
Release
See releases for publish versions of the ui-bundle zip.
Development
Original docs for full help.
For a link of all the gulp tasks
$ gulp --tasks-simple
Preview the UI
The default UI project is configured to preview offline.
The files in the preview-src/ folder provide the sample content that allow you to see the UI in action.
In this folder, you’ll primarily find pages written in AsciiDoc.
These pages provide a representative sample and kitchen sink of content from the real site.
To build the UI and preview it in a local web server, run the preview command:
$ gulp preview
You’ll see a URL listed in the output of this command:
[12:00:00] Starting server...
[12:00:00] Server started http://localhost:5252
[12:00:00] Running server
Navigate to this URL to preview the site locally.
While this command is running, any changes you make to the source files will be instantly reflected in the browser.
This works by monitoring the project for changes, running the preview:build task if a change is detected, and sending the updates to the browser.
Press kbd:[Ctrl+C] to stop the preview server and end the continuous build.
Package for Use with Antora
If you need to package the UI so you can use it to generate the documentation site locally, run the following command:
$ gulp bundle
If any errors are reported by lint, you’ll need to fix them.
When the command completes successfully, the UI bundle will be available at build/ui-bundle.zip.
You can point Antora at this bundle using the --ui-bundle-url command-line option.
If you have the preview running, and you want to bundle without causing the preview to be clobbered, use:
$ gulp bundle:pack
The UI bundle will again be available at build/ui-bundle.zip.
Source Maps
The build consolidates all the CSS and client-side JavaScript into combined files, site.css and site.js, respectively, in order to reduce the size of the bundle.
{url-source-maps}[Source maps] correlate these combined files with their original sources.
This “source mapping” is accomplished by generating additional map files that make this association.
These map files sit adjacent to the combined files in the build folder.
The mapping they provide allows the debugger to present the original source rather than the obfuscated file, an essential tool for debugging.
In preview mode, source maps are enabled automatically, so there’s nothing you have to do to make use of them.
If you need to include source maps in the bundle, you can do so by setting the SOURCEMAPS environment variable to true when you run the bundle command:
$ SOURCEMAPS=true gulp bundle
In this case, the bundle will include the source maps, which can be used for debugging your production site.
Merge Upstream
git remote add upstream git@gitlab.com:antora/antora-ui-default.git
git fetch upstream
git checkout master
git merge --no-ff upstream/master
About
Fork of default antora ui.
countableset.github.io/antora-ui/
Resources
Readme
MPL-2.0 license
Activity
Stars
2 stars
Watchers
1 watching
Forks
3 forks
Report repository
Releases
Packages
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
GitHub - countableSet/antora-ui: Fork of default antora ui. · GitHub
Skip to content
BranchesTags
Repository files navigation
Antora Default UI Customized
This is forked version of the antora default ui.
Enhancements that have been made to the original are:
  • light/dark mode and theme switcher button
  • github highlightjs styles for light/dark modes
  • source code tabs
  • styled admonition blocks with icons
  • font-awesome 4 (font and css)
  • widens main content panel by percentages #10
  • replace Roboto font with system font #11
Release
See releases for publish versions of the ui-bundle zip.
Development
Original docs for full help.
For a link of all the gulp tasks
$ gulp --tasks-simple
Preview the UI
The default UI project is configured to preview offline.
The files in the preview-src/ folder provide the sample content that allow you to see the UI in action.
In this folder, you’ll primarily find pages written in AsciiDoc.
These pages provide a representative sample and kitchen sink of content from the real site.
To build the UI and preview it in a local web server, run the preview command:
$ gulp preview
You’ll see a URL listed in the output of this command:
[12:00:00] Starting server...
[12:00:00] Server started http://localhost:5252
[12:00:00] Running server
Navigate to this URL to preview the site locally.
While this command is running, any changes you make to the source files will be instantly reflected in the browser.
This works by monitoring the project for changes, running the preview:build task if a change is detected, and sending the updates to the browser.
Press kbd:[Ctrl+C] to stop the preview server and end the continuous build.
Package for Use with Antora
If you need to package the UI so you can use it to generate the documentation site locally, run the following command:
$ gulp bundle
If any errors are reported by lint, you’ll need to fix them.
When the command completes successfully, the UI bundle will be available at build/ui-bundle.zip.
You can point Antora at this bundle using the --ui-bundle-url command-line option.
If you have the preview running, and you want to bundle without causing the preview to be clobbered, use:
$ gulp bundle:pack
The UI bundle will again be available at build/ui-bundle.zip.
Source Maps
The build consolidates all the CSS and client-side JavaScript into combined files, site.css and site.js, respectively, in order to reduce the size of the bundle.
{url-source-maps}[Source maps] correlate these combined files with their original sources.
This “source mapping” is accomplished by generating additional map files that make this association.
These map files sit adjacent to the combined files in the build folder.
The mapping they provide allows the debugger to present the original source rather than the obfuscated file, an essential tool for debugging.
In preview mode, source maps are enabled automatically, so there’s nothing you have to do to make use of them.
If you need to include source maps in the bundle, you can do so by setting the SOURCEMAPS environment variable to true when you run the bundle command:
$ SOURCEMAPS=true gulp bundle
In this case, the bundle will include the source maps, which can be used for debugging your production site.
Merge Upstream
git remote add upstream git@gitlab.com:antora/antora-ui-default.git
git fetch upstream
git checkout master
git merge --no-ff upstream/master
About
Fork of default antora ui.
countableset.github.io/antora-ui/
Resources
Readme
MPL-2.0 license
Activity
Stars
2 stars
Watchers
1 watching
Forks
3 forks
Report repository
Releases
Packages
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
GitHub - countableSet/antora-ui: Fork of default antora ui. · GitHub
Skip to content
BranchesTags
Repository files navigation
Antora Default UI Customized
This is forked version of the antora default ui.
Enhancements that have been made to the original are:
  • light/dark mode and theme switcher button
  • github highlightjs styles for light/dark modes
  • source code tabs
  • styled admonition blocks with icons
  • font-awesome 4 (font and css)
  • widens main content panel by percentages #10
  • replace Roboto font with system font #11
Release
See releases for publish versions of the ui-bundle zip.
Development
Original docs for full help.
For a link of all the gulp tasks
$ gulp --tasks-simple
Preview the UI
The default UI project is configured to preview offline.
The files in the preview-src/ folder provide the sample content that allow you to see the UI in action.
In this folder, you’ll primarily find pages written in AsciiDoc.
These pages provide a representative sample and kitchen sink of content from the real site.
To build the UI and preview it in a local web server, run the preview command:
$ gulp preview
You’ll see a URL listed in the output of this command:
[12:00:00] Starting server...
[12:00:00] Server started http://localhost:5252
[12:00:00] Running server
Navigate to this URL to preview the site locally.
While this command is running, any changes you make to the source files will be instantly reflected in the browser.
This works by monitoring the project for changes, running the preview:build task if a change is detected, and sending the updates to the browser.
Press kbd:[Ctrl+C] to stop the preview server and end the continuous build.
Package for Use with Antora
If you need to package the UI so you can use it to generate the documentation site locally, run the following command:
$ gulp bundle
If any errors are reported by lint, you’ll need to fix them.
When the command completes successfully, the UI bundle will be available at build/ui-bundle.zip.
You can point Antora at this bundle using the --ui-bundle-url command-line option.
If you have the preview running, and you want to bundle without causing the preview to be clobbered, use:
$ gulp bundle:pack
The UI bundle will again be available at build/ui-bundle.zip.
Source Maps
The build consolidates all the CSS and client-side JavaScript into combined files, site.css and site.js, respectively, in order to reduce the size of the bundle.
{url-source-maps}[Source maps] correlate these combined files with their original sources.
This “source mapping” is accomplished by generating additional map files that make this association.
These map files sit adjacent to the combined files in the build folder.
The mapping they provide allows the debugger to present the original source rather than the obfuscated file, an essential tool for debugging.
In preview mode, source maps are enabled automatically, so there’s nothing you have to do to make use of them.
If you need to include source maps in the bundle, you can do so by setting the SOURCEMAPS environment variable to true when you run the bundle command:
$ SOURCEMAPS=true gulp bundle
In this case, the bundle will include the source maps, which can be used for debugging your production site.
Merge Upstream
git remote add upstream git@gitlab.com:antora/antora-ui-default.git
git fetch upstream
git checkout master
git merge --no-ff upstream/master
About
Fork of default antora ui.
countableset.github.io/antora-ui/
Resources
Readme
MPL-2.0 license
Activity
Stars
2 stars
Watchers
1 watching
Forks
3 forks
Report repository
Releases
Packages
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
GitHub - countableSet/antora-ui: Fork of default antora ui. · GitHub
Skip to content
BranchesTags
Repository files navigation
Antora Default UI Customized
This is forked version of the antora default ui.
Enhancements that have been made to the original are:
  • light/dark mode and theme switcher button
  • github highlightjs styles for light/dark modes
  • source code tabs
  • styled admonition blocks with icons
  • font-awesome 4 (font and css)
  • widens main content panel by percentages #10
  • replace Roboto font with system font #11
Release
See releases for publish versions of the ui-bundle zip.
Development
Original docs for full help.
For a link of all the gulp tasks
$ gulp --tasks-simple
Preview the UI
The default UI project is configured to preview offline.
The files in the preview-src/ folder provide the sample content that allow you to see the UI in action.
In this folder, you’ll primarily find pages written in AsciiDoc.
These pages provide a representative sample and kitchen sink of content from the real site.
To build the UI and preview it in a local web server, run the preview command:
$ gulp preview
You’ll see a URL listed in the output of this command:
[12:00:00] Starting server...
[12:00:00] Server started http://localhost:5252
[12:00:00] Running server
Navigate to this URL to preview the site locally.
While this command is running, any changes you make to the source files will be instantly reflected in the browser.
This works by monitoring the project for changes, running the preview:build task if a change is detected, and sending the updates to the browser.
Press kbd:[Ctrl+C] to stop the preview server and end the continuous build.
Package for Use with Antora
If you need to package the UI so you can use it to generate the documentation site locally, run the following command:
$ gulp bundle
If any errors are reported by lint, you’ll need to fix them.
When the command completes successfully, the UI bundle will be available at build/ui-bundle.zip.
You can point Antora at this bundle using the --ui-bundle-url command-line option.
If you have the preview running, and you want to bundle without causing the preview to be clobbered, use:
$ gulp bundle:pack
The UI bundle will again be available at build/ui-bundle.zip.
Source Maps
The build consolidates all the CSS and client-side JavaScript into combined files, site.css and site.js, respectively, in order to reduce the size of the bundle.
{url-source-maps}[Source maps] correlate these combined files with their original sources.
This “source mapping” is accomplished by generating additional map files that make this association.
These map files sit adjacent to the combined files in the build folder.
The mapping they provide allows the debugger to present the original source rather than the obfuscated file, an essential tool for debugging.
In preview mode, source maps are enabled automatically, so there’s nothing you have to do to make use of them.
If you need to include source maps in the bundle, you can do so by setting the SOURCEMAPS environment variable to true when you run the bundle command:
$ SOURCEMAPS=true gulp bundle
In this case, the bundle will include the source maps, which can be used for debugging your production site.
Merge Upstream
git remote add upstream git@gitlab.com:antora/antora-ui-default.git
git fetch upstream
git checkout master
git merge --no-ff upstream/master
About
Fork of default antora ui.
countableset.github.io/antora-ui/
Resources
Readme
MPL-2.0 license
Activity
Stars
2 stars
Watchers
1 watching
Forks
3 forks
Report repository
Releases
Packages
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
GitHub - countableSet/antora-ui: Fork of default antora ui. · GitHub
Skip to content
BranchesTags
Repository files navigation
Antora Default UI Customized
This is forked version of the antora default ui.
Enhancements that have been made to the original are:
  • light/dark mode and theme switcher button
  • github highlightjs styles for light/dark modes
  • source code tabs
  • styled admonition blocks with icons
  • font-awesome 4 (font and css)
  • widens main content panel by percentages #10
  • replace Roboto font with system font #11
Release
See releases for publish versions of the ui-bundle zip.
Development
Original docs for full help.
For a link of all the gulp tasks
$ gulp --tasks-simple
Preview the UI
The default UI project is configured to preview offline.
The files in the preview-src/ folder provide the sample content that allow you to see the UI in action.
In this folder, you’ll primarily find pages written in AsciiDoc.
These pages provide a representative sample and kitchen sink of content from the real site.
To build the UI and preview it in a local web server, run the preview command:
$ gulp preview
You’ll see a URL listed in the output of this command:
[12:00:00] Starting server...
[12:00:00] Server started http://localhost:5252
[12:00:00] Running server
Navigate to this URL to preview the site locally.
While this command is running, any changes you make to the source files will be instantly reflected in the browser.
This works by monitoring the project for changes, running the preview:build task if a change is detected, and sending the updates to the browser.
Press kbd:[Ctrl+C] to stop the preview server and end the continuous build.
Package for Use with Antora
If you need to package the UI so you can use it to generate the documentation site locally, run the following command:
$ gulp bundle
If any errors are reported by lint, you’ll need to fix them.
When the command completes successfully, the UI bundle will be available at build/ui-bundle.zip.
You can point Antora at this bundle using the --ui-bundle-url command-line option.
If you have the preview running, and you want to bundle without causing the preview to be clobbered, use:
$ gulp bundle:pack
The UI bundle will again be available at build/ui-bundle.zip.
Source Maps
The build consolidates all the CSS and client-side JavaScript into combined files, site.css and site.js, respectively, in order to reduce the size of the bundle.
{url-source-maps}[Source maps] correlate these combined files with their original sources.
This “source mapping” is accomplished by generating additional map files that make this association.
These map files sit adjacent to the combined files in the build folder.
The mapping they provide allows the debugger to present the original source rather than the obfuscated file, an essential tool for debugging.
In preview mode, source maps are enabled automatically, so there’s nothing you have to do to make use of them.
If you need to include source maps in the bundle, you can do so by setting the SOURCEMAPS environment variable to true when you run the bundle command:
$ SOURCEMAPS=true gulp bundle
In this case, the bundle will include the source maps, which can be used for debugging your production site.
Merge Upstream
git remote add upstream git@gitlab.com:antora/antora-ui-default.git
git fetch upstream
git checkout master
git merge --no-ff upstream/master
About
Fork of default antora ui.
countableset.github.io/antora-ui/
Resources
Readme
MPL-2.0 license
Activity
Stars
2 stars
Watchers
1 watching
Forks
3 forks
Report repository
Releases
Packages
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
GitHub - countableSet/antora-ui: Fork of default antora ui. · GitHub
Skip to content
BranchesTags
Repository files navigation
Antora Default UI Customized
This is forked version of the antora default ui.
Enhancements that have been made to the original are:
  • light/dark mode and theme switcher button
  • github highlightjs styles for light/dark modes
  • source code tabs
  • styled admonition blocks with icons
  • font-awesome 4 (font and css)
  • widens main content panel by percentages #10
  • replace Roboto font with system font #11
Release
See releases for publish versions of the ui-bundle zip.
Development
Original docs for full help.
For a link of all the gulp tasks
$ gulp --tasks-simple
Preview the UI
The default UI project is configured to preview offline.
The files in the preview-src/ folder provide the sample content that allow you to see the UI in action.
In this folder, you’ll primarily find pages written in AsciiDoc.
These pages provide a representative sample and kitchen sink of content from the real site.
To build the UI and preview it in a local web server, run the preview command:
$ gulp preview
You’ll see a URL listed in the output of this command:
[12:00:00] Starting server...
[12:00:00] Server started http://localhost:5252
[12:00:00] Running server
Navigate to this URL to preview the site locally.
While this command is running, any changes you make to the source files will be instantly reflected in the browser.
This works by monitoring the project for changes, running the preview:build task if a change is detected, and sending the updates to the browser.
Press kbd:[Ctrl+C] to stop the preview server and end the continuous build.
Package for Use with Antora
If you need to package the UI so you can use it to generate the documentation site locally, run the following command:
$ gulp bundle
If any errors are reported by lint, you’ll need to fix them.
When the command completes successfully, the UI bundle will be available at build/ui-bundle.zip.
You can point Antora at this bundle using the --ui-bundle-url command-line option.
If you have the preview running, and you want to bundle without causing the preview to be clobbered, use:
$ gulp bundle:pack
The UI bundle will again be available at build/ui-bundle.zip.
Source Maps
The build consolidates all the CSS and client-side JavaScript into combined files, site.css and site.js, respectively, in order to reduce the size of the bundle.
{url-source-maps}[Source maps] correlate these combined files with their original sources.
This “source mapping” is accomplished by generating additional map files that make this association.
These map files sit adjacent to the combined files in the build folder.
The mapping they provide allows the debugger to present the original source rather than the obfuscated file, an essential tool for debugging.
In preview mode, source maps are enabled automatically, so there’s nothing you have to do to make use of them.
If you need to include source maps in the bundle, you can do so by setting the SOURCEMAPS environment variable to true when you run the bundle command:
$ SOURCEMAPS=true gulp bundle
In this case, the bundle will include the source maps, which can be used for debugging your production site.
Merge Upstream
git remote add upstream git@gitlab.com:antora/antora-ui-default.git
git fetch upstream
git checkout master
git merge --no-ff upstream/master
About
Fork of default antora ui.
countableset.github.io/antora-ui/
Resources
Readme
MPL-2.0 license
Activity
Stars
2 stars
Watchers
1 watching
Forks
3 forks
Report repository
Releases
Packages
Used by
Contributors
Languages