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

Improve use-case navigation #64

Open
k-wall opened this issue Aug 20, 2024 · 1 comment
Open

Improve use-case navigation #64

k-wall opened this issue Aug 20, 2024 · 1 comment

Comments

@k-wall
Copy link
Contributor

k-wall commented Aug 20, 2024

          What's the goal? To be able to navigate _to_ each use case, or to be able to navigate _within_ each use case? If you look at what's been done for the [docs layout](https://github.com/kroxylicious/kroxylicious.github.io/blob/main/_layouts/docs.html), with the internal navigation in a sidebar, does that sort of achieve what you're after?

If we want to repurpose that layout for the use cases we'll have to duplicate it, the docs layout is set up to process AsciiDoc rather than markdown.

Otherwise if you just want buttons that take you to each use case, there's always the Slugify filter. Something like:

{% for use_case in site.use_cases %}
    {% include my_cool_button.html label=use_case.name %}
{% endfor %}

and then in _includes/my_cool_button.html you'd have something like this (bootstrap button docs):

<button type="button" class="btn btn-primary" href="#{{ name | slugify }}">
    {{ name }}
</button>

and then you just arrange those buttons however you'd like by adding structure around them with grid components in _layouts/use_cases.html (you wouldn't need the card-text div in that case). The name property already exists in the existing use case front matter so it's just a matter of passing it through slugify to get something URL-safe.

Originally posted by @gracegrimwood in #63 (comment)

@k-wall
Copy link
Contributor Author

k-wall commented Aug 21, 2024

What's the goal? To be able to navigate to each use case, or to be able to navigate within each use case?

really the former. currently, if you click on the use-case navigation you see "record encryption". There's nothing obvious that lets the reader know there's further use-cases below. I vomited a TOC onto the page (sorry) as a quick and dirty solution.

Unfortunately, I don't have the jekyll skills (or the available bandwidth right now to learn).. so if you'd be able to make a suggestion, that would be appreciated.

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

No branches or pull requests

1 participant