Antora Default UI issueshttps://gitlab.com/antora/antora-ui-default/-/issues2024-02-07T09:55:28Zhttps://gitlab.com/antora/antora-ui-default/-/issues/217Add Julia to supported languages in syntax highlighting2024-02-07T09:55:28ZBeni BilmeAdd Julia to supported languages in syntax highlightingHello,
I am writing a tutorial/documentation in antora about a julia programming language and to my surprise, it is not supported in highlight.js in antora ui. According to `highlight.js` at [GitHub](https://github.com/highlightjs/high...Hello,
I am writing a tutorial/documentation in antora about a julia programming language and to my surprise, it is not supported in highlight.js in antora ui. According to `highlight.js` at [GitHub](https://github.com/highlightjs/highlight.js/blob/main/SUPPORTED_LANGUAGES.md), julia is being supported among other 192 languages.
I kindly request addition of Julia to the list of languages whose syntax are supported in Antora UI.Dan AllenDan Allenhttps://gitlab.com/antora/antora-ui-default/-/issues/216Feature Request: Dark Mode2023-12-28T09:28:33ZParker MooreFeature Request: Dark ModeHey everyone,
I noticed that https://docs.rubocop.org uses Antora UI Default and also noticed that in dark mode, the site is extremely bright. With `@media (prefers-color-scheme: dark)` available in CSS these days, I was wondering if it...Hey everyone,
I noticed that https://docs.rubocop.org uses Antora UI Default and also noticed that in dark mode, the site is extremely bright. With `@media (prefers-color-scheme: dark)` available in CSS these days, I was wondering if it might be possible to support some kind of dark mode. I'd personally model it after the excellent https://developer.mozilla.org color scheme, but you may have different wishes for a dark mode. Is this something that could be considered for antora-default-ui?
Thanks!https://gitlab.com/antora/antora-ui-default/-/issues/215Hide version in explore panel if component is versionless2023-11-30T09:22:17ZDan AllenHide version in explore panel if component is versionlessIf a component is versionless (meaning it only has one version and that version is an empty string), and the display version is "default", hide the version in the explore panel.
This enhancement has been implemented in the UI for the As...If a component is versionless (meaning it only has one version and that version is an empty string), and the display version is "default", hide the version in the explore panel.
This enhancement has been implemented in the UI for the Asciidoctor docs, which can serve as a reference. See:
* https://docs.asciidoctor.org/
* https://github.com/asciidoctor/asciidoctor-docs-ui/blob/main/src/partials/nav-explore.hbshttps://gitlab.com/antora/antora-ui-default/-/issues/214Static files under `src` are not added to UI-bundle2023-11-04T07:14:18ZAntonio VieiroStatic files under `src` are not added to UI-bundleDocumentation at https://docs.antora.org/antora-ui-default/add-static-files/ states that static files can be placed immediately under the `src` folder. The fact is that static files must be placed under the `src/static` folder, and they ...Documentation at https://docs.antora.org/antora-ui-default/add-static-files/ states that static files can be placed immediately under the `src` folder. The fact is that static files must be placed under the `src/static` folder, and they automatically get promoted to the top of the resulting ui-bundle.
To test this:
- Clone the repository and install dependencies.
- `echo "Hello" > src/hello.txt`
- `mkdir src/static`
- `echo "Bye" > src/static/bye.txt`
- `npx gulp`
- `unzip -l build/ui-bundle.zip | grep txt`
Only `bye.txt` is added to the root of the `ui-bundle.zip` file.Dan AllenDan Allenhttps://gitlab.com/antora/antora-ui-default/-/issues/213Antora Default UI doesn't have Cyrillic fonts2023-11-26T04:05:48ZPavel PoglazovAntora Default UI doesn't have Cyrillic fontsBesides the obvious drawbacks, it causes unpredictable behavior in some cases.
I have already created a PR to fix this, please find all details here: !177Besides the obvious drawbacks, it causes unpredictable behavior in some cases.
I have already created a PR to fix this, please find all details here: !177https://gitlab.com/antora/antora-ui-default/-/issues/212.big and .small not implemented2023-10-04T07:07:44ZAdrian Hall.big and .small not implementedThe `.big` and `.small` roles are not included in the UI bundle.The `.big` and `.small` roles are not included in the UI bundle.Adrian HallAdrian Hallhttps://gitlab.com/antora/antora-ui-default/-/issues/211Version and publish UI bundle to a package repository2024-01-16T21:09:57ZDan AllenVersion and publish UI bundle to a package repositoryThe default UI started out as a template project for creating a custom UI. However, when we started publishing the produced UI bundle as a CI artifact, users (including the Antora project itself) started hot linking to it as a release. T...The default UI started out as a template project for creating a custom UI. However, when we started publishing the produced UI bundle as a CI artifact, users (including the Antora project itself) started hot linking to it as a release. This situation is problematic for several reasons:
* The URL of the published artifact is awkward
* During a build, the URL becomes unavailable
* The bundle is not versioned, so every change invokes a rolling update
* Lack of versioning is locking us into supporting IE and ES5 (since those runtimes were supported when the bundle was first made available)
* We can't rename the default branch from master to main because it changes the URL of the published artifact
There's also the problem that the name of the project is misleading. This project is really meant to be a reference for how to make a UI rather than a default. So we might consider renaming it.
One way to version and publish the UI is to publish it as an npm package. That would allow the UI to be installed alongside Antora. Since Antora now supports loading the UI bundle from a directory, it can point to the installed path of the package. However, a lot of users will probably still prefer to linking to the UI from a public URL, so we will need to think about where to publish it. We could use the package and/or releases facility in this repository as that can be assumed to be more stable, certainly more so than a CI artifact.https://gitlab.com/antora/antora-ui-default/-/issues/210Consider moving away from Gulp2023-10-03T07:42:34ZHoang NguyenConsider moving away from Gulp### Why?
- `gulpjs` upstream hasn't had any new commits since Dec 2022. The project is not officially dead (of course), but the development has been slow.
- The JS code for the gulp tasks in this repo is pretty complex (for someone new t...### Why?
- `gulpjs` upstream hasn't had any new commits since Dec 2022. The project is not officially dead (of course), but the development has been slow.
- The JS code for the gulp tasks in this repo is pretty complex (for someone new to JS like me to understand and fork a custom theme of).
### What should we use instead?
[vitejs](https://github.com/vitejs/vite) seems to gain quite a lot of traction lately. I'm no where familiar with either gulp or vite, but from the surface it looks like a good alternative.
There is a plugin to handle Handlebar templates (https://github.com/vituum/vite-plugin-handlebars). For the building preview task, we might need to implement ourselves, as we currently do with gulp.
**Pros:**
- Has a lot of functionalities baked in, so we don't need to reinvent the wheel
- Seems to be pretty fast
**Cons:**
- Opinionated (things may work the way we don't like it to)https://gitlab.com/antora/antora-ui-default/-/issues/209Admonition block rendering of paragraph content "floats right" in flex-box2023-09-19T18:35:38ZTimothy StoneAdmonition block rendering of paragraph content "floats right" in flex-boxGiven the following code example:
```yaml
[IMPORTANT]
====
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
incididunt ut labore et dolore magna aliqua.
Viverra vitae congue eu consequat ac felis donec et....Given the following code example:
```yaml
[IMPORTANT]
====
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
incididunt ut labore et dolore magna aliqua.
Viverra vitae congue eu consequat ac felis donec et. Dui nunc mattis enim ut
tellus. Aliquet sagittis id consectetur purus ut faucibus pulvinar. Ac turpis
egestas maecenas pharetra convallis posuere morbi leo urna. Facilisis volutpat
est velit egestas dui id ornare arcu odio.
====
```
Antora is rendering the following:
![image](/uploads/c319da313d54c5a75c41887b24b3ec37/image.png)
I don't see any relative or absolute positioning and it appears some flex is being applied, but changing that does not correct it. It renders correctly in IntelliJ (see below). Constraining the view port seems to correct the issue as well (see below).
IntelliJ Rendering
![image](/uploads/6f8af602bdac0515300f8c1083feb24a/image.png)
Constraining Viewport
![image](/uploads/8b1d3874d97d196de6d716bd978b840e/image.png)https://gitlab.com/antora/antora-ui-default/-/issues/208CSS cache-busting2023-09-07T09:17:49ZAlex WalkerCSS cache-busting`site.css` is cacheable by browsers, but I'm not aware of any cache-busting strategy (e.g. appending a hash of the file content to the filename) natively supported by the Antora Default UI. As a result, users do not always see the latest...`site.css` is cacheable by browsers, but I'm not aware of any cache-busting strategy (e.g. appending a hash of the file content to the filename) natively supported by the Antora Default UI. As a result, users do not always see the latest version of a site built using Antora Default UI.
Ideally, the project would support cache-busting. For now, what's the best way to handle this?
(This issue probably also affects JS files)https://gitlab.com/antora/antora-ui-default/-/issues/207Allow large tables to overlay the right-side TOC2023-08-14T17:01:06ZIoannis StavrakakisAllow large tables to overlay the right-side TOCAllow a large table to overlay the right-hand side ToC.
![image](/uploads/10aff58d9e26b76bf459ad2a27a66ad1/image.png)
See https://asciidoctor.zulipchat.com/#narrow/stream/279642-users/topic/horizontal.20scroll.20for.20large.20tables/ne...Allow a large table to overlay the right-hand side ToC.
![image](/uploads/10aff58d9e26b76bf459ad2a27a66ad1/image.png)
See https://asciidoctor.zulipchat.com/#narrow/stream/279642-users/topic/horizontal.20scroll.20for.20large.20tables/near/321055258
and
https://antora.zulipchat.com/#narrow/stream/282400-users/topic/.E2.9C.94.20Body.20content.20overlapping.20right-hand.20side.20TOChttps://gitlab.com/antora/antora-ui-default/-/issues/206Not able to read the repository and sorces present Antora local cache2023-06-18T08:38:18Zananta-codeNot able to read the repository and sorces present Antora local cacheHi,
During Antora build ,all the repositories are cached in a PVC for my application but when i go to local cache and check for each repository i didn't find the source files there.
Is there any way to read a repo and it is sources from...Hi,
During Antora build ,all the repositories are cached in a PVC for my application but when i go to local cache and check for each repository i didn't find the source files there.
Is there any way to read a repo and it is sources from Antora local cache by using some sort of command in shell script?https://gitlab.com/antora/antora-ui-default/-/issues/205left navigation panel and right navigation panel should be toggleable2023-06-09T06:34:54ZNagleft navigation panel and right navigation panel should be toggleableLeft navigation panel and right navigation panel should be toggleable, so that more reading space will be aviable for content.Left navigation panel and right navigation panel should be toggleable, so that more reading space will be aviable for content.https://gitlab.com/antora/antora-ui-default/-/issues/204UI position error on MacOS system.2023-06-01T09:20:53Z大胃王UI position error on MacOS system.I successfully built my own document, which looks normal on Windows operating system, but there are some position abnormalities when viewing it on MacBookPro devices. I don't know if it's an operating system problem or a screen size prob...I successfully built my own document, which looks normal on Windows operating system, but there are some position abnormalities when viewing it on MacBookPro devices. I don't know if it's an operating system problem or a screen size problem. How can I make them look the same?
![image](/uploads/ff0cf44d46515895f3ed98c613994179/image.png)
And I found the same issue in the official document as well.
![image](/uploads/68a9b0dc75ca1db119f942b0b0cc4434/image.png)https://gitlab.com/antora/antora-ui-default/-/issues/203Upgrade highlight.js to latest version2023-07-08T22:15:11ZStefano OttolenghiUpgrade highlight.js to latest versionThe UI bundle currently uses version 9 of highlight.js, which has reached End Of Life. Latest version is [v11](https://highlightjs.readthedocs.io/en/latest/upgrade-11.html), although [there are issues with callouts](https://github.com/st...The UI bundle currently uses version 9 of highlight.js, which has reached End Of Life. Latest version is [v11](https://highlightjs.readthedocs.io/en/latest/upgrade-11.html), although [there are issues with callouts](https://github.com/stackabletech/documentation/issues/232) not being correctly rendered (and I can confirm the issue).https://gitlab.com/antora/antora-ui-default/-/issues/202Google analytics doesn't work2023-01-03T22:51:00ZArtemGoogle analytics doesn't workGoogle analytics recommend code:
```
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-xxx"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(ar...Google analytics recommend code:
```
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-xxx"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-xxx');
</script>
```
head-scripts.hbs contains code:
```
<script>function gtag(){dataLayer.push(arguments)};window.dataLayer=window.dataLayer||[];gtag('js',new Date());gtag('config','{{this}}')</script>
```
but should:
```
<script>window.dataLayer=window.dataLayer||[];function gtag(){dataLayer.push(arguments);}gtag('js',new Date());gtag('config','{{this}}');</script>
```
I am not JavaScript expert, but this code (= code in head-scripts.hbs) doesn't suite google recommendations. Thankshttps://gitlab.com/antora/antora-ui-default/-/issues/201Fonts are not bundled if built on Windows2023-06-19T15:58:37ZMartin HillerFonts are not bundled if built on WindowsIf the UI is built on a Windows machine (e.g., Windows 10) with:
```
npm install
npx gulp bundle
```
Then the produced bundle under `build/ui-bundle.zip` does not contain the `font` folder with the Roboto fonts. The URLs in `css/site.css...If the UI is built on a Windows machine (e.g., Windows 10) with:
```
npm install
npx gulp bundle
```
Then the produced bundle under `build/ui-bundle.zip` does not contain the `font` folder with the Roboto fonts. The URLs in `css/site.css` still refer to the unresolved `~@fontsource/roboto/files/roboto-*.woff2` font paths.Martin HillerMartin Hillerhttps://gitlab.com/antora/antora-ui-default/-/issues/200Document using the resolvePage and resolvePageURL helpers2022-10-27T02:43:27ZSarah WhiteDocument using the resolvePage and resolvePageURL helpersDan provided this example as a basis (https://gitlab.com/antora/antora/-/issues/333#note_1135418394):
To be clear, it's now possible to resolve a page or page URL from the UI template using the built-in `resolvePage` and `resolvePageURL...Dan provided this example as a basis (https://gitlab.com/antora/antora/-/issues/333#note_1135418394):
To be clear, it's now possible to resolve a page or page URL from the UI template using the built-in `resolvePage` and `resolvePageURL` helpers, respectively. For example:
```
<a href="{{{relativize (resolvePageURL 'product::index.adoc')}}}">Product</a>
```
or
```
{{#with (resolvePage 'product::index.adoc')}}
<a href="{{{relativize ./url}}}">{{{./title}}}</a>
{{/with}}
```
You can see this used through the [Asciidoctor docs UI](https://github.com/asciidoctor/asciidoctor-docs-ui/tree/main/src/partials).https://gitlab.com/antora/antora-ui-default/-/issues/199Configurable depth in "Contents" area2022-10-17T08:36:29ZDaniel WolfConfigurable depth in "Contents" areaThe "Contents" area at the right-hand side always displays two levels. As shown in the screenshot below, this isn't always ideal. It would be great if the "Contents" area respected the document's `toclevels` attribute.
On a related note...The "Contents" area at the right-hand side always displays two levels. As shown in the screenshot below, this isn't always ideal. It would be great if the "Contents" area respected the document's `toclevels` attribute.
On a related note, I believe it would make sense for Antora to ignore the `toc` attribute. Given that the "Contents" area effectively serves as a ToC, having a separate ToC in the document looks a bit redundant to me.
![image](/uploads/2fe62f77f30fa5eb12155001253f4df4/image.png)https://gitlab.com/antora/antora-ui-default/-/issues/198Toggle expand/collapse navigation menu2023-11-09T09:32:37ZVladimir MarkievToggle expand/collapse navigation menuThe asciidoctor.org site has a function to expand or collapse all navigation menu items. It would be a very helpful addition for large navs.
The feature would need to be inheritable by extensions that modify the navigation menu too.The asciidoctor.org site has a function to expand or collapse all navigation menu items. It would be a very helpful addition for large navs.
The feature would need to be inheritable by extensions that modify the navigation menu too.