Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Various updates to address recently raised issues #206

Merged
merged 14 commits into from
Mar 6, 2024

Conversation

philwebb
Copy link
Contributor

This PR contains a number of commits to address recently raised issue. Since some fixes build on others it's hard to send individual PRs.

Add `.vscode` to `.gitignore` to prevent it from accidentally
being added.
Update `asciidocExtensionRegistered.js` so that the resolve call
doesn't pass a path. This allows the the function to work when
running `gulp preview`.

Fixes spring-io#200
The current file is hard to modify so this scrip allows us to recreate
it easily using just the icon names.

Closes #
Update the font-awesome CSS by using the version provided by
https://gitlab.com/antora/antora-ui-default/-/merge_requests/121 which
does not clash with admon CSS.

Fixes spring-io#202
Update the list of highlight.js languages to include 'http'
which is used by Spring Restdocs generated content.

Closes spring-io#204
Refactor existing CSS to build on top of antora-default-ui CSS.
This update allows us to apply our CSS tweaks on top of the
standard Antora UI which should help us keep it in sync.

In addition, the updated CSS provides the following changes:

- Admon block styling has been updated to improve the look
- Reduced contrast is now used for the dark theme
- Callout formatting has been improved
- The breadcrumb area has been moved to allow the main
  <article> tag to have the `doc` class applied. Without this
  change the default Antora CSS does not apply correctly.
- Anchor hover positions have been improved.
- Toolbox and Tab buttons have hover colors.
- Tables can scroll horizontally when there is unbreakable
  content.
- Spring specific css is prefixed with `spring-` to make the
  files easier to find from browser devtools.
- Page bounce has been disabled

Closes spring-io#205
Update CSS to use system fonts for body and heading.

Closes spring-io#115
@oodamien oodamien merged commit ebfd571 into spring-io:main Mar 6, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants