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

Support anchors in guides #561

Open
mabartos opened this issue Feb 6, 2025 · 0 comments · May be fixed by #566
Open

Support anchors in guides #561

mabartos opened this issue Feb 6, 2025 · 0 comments · May be fixed by #566

Comments

@mabartos
Copy link
Contributor

mabartos commented Feb 6, 2025

Description

When referencing some particular section of our documentation/guide to our users, we need to be able to create a link for the required section. However, in the current state of guides published on keycloak-web, it is quite hard to do it.

Even though some sections can be referenced after clicking on the list of sections on the right side, in most cases it cannot be applied to all subsections.

It'd be great to provide anchors for these sections. Ideally, when you hover over the section title, the icon on the left is displayed, and after clicking on that, the URL is changed, and you can easily share it.

When guides are generated in the keycloak/keycloak repository, these anchors are visible, but not on the web.

Example of a Quarkus guide with the anchor:

Image

Our guides don't have it:

Image

Discussion

No response

Motivation

Improves referencing particular sections of guides to users

Details

No response

stianst added a commit to stianst/keycloak-web that referenced this issue Feb 13, 2025
Closes keycloak#561

Signed-off-by: stianst <[email protected]>
@stianst stianst linked a pull request Feb 13, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant