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

Add header anchors #48

Merged
merged 2 commits into from
May 26, 2021
Merged

Add header anchors #48

merged 2 commits into from
May 26, 2021

Conversation

szarnyasg
Copy link
Collaborator

I added anchor headings using the trick / HTML template given in https://github.com/allejo/jekyll-anchor-headings.

It uses the link emoji so its look is platform dependent.

image

@hannes
Copy link
Member

hannes commented May 6, 2021

@Franz-Kafka can you have a look at this please?

@szarnyasg
Copy link
Collaborator Author

A potential alternative: https://www.bryanbraun.com/anchorjs/

@Mytherin
Copy link
Collaborator

Thanks for the contribution! This seems good and useful to me. I specifically like the ability to link to specific headers. I am personally not a big fan of how the anchors look, though, at least on MacOS.

Screenshot 2021-05-18 at 14 42 20

Rather than have a separate icon, perhaps we can just make the headers themselves clickable with this behavior?

@szarnyasg
Copy link
Collaborator Author

Indeed, they don't look that good and they are emojis so they vary a lot between platforms. So we should either:

  1. Use links as you suggested. I implemented this, you can take a look with:
cd /tmp && git clone git@github.com:szarnyasg/duckdb-web --branch anchors --depth 1 && cd duckdb-web && jekyll serve
  1. Use an image file, e.g. based on the examples here: https://www.bryanbraun.com/anchorjs/#examples

@Mytherin
Copy link
Collaborator

The clickable links look good to me. Thanks for making the changes!

@Mytherin Mytherin merged commit 00e88c2 into duckdb:master May 26, 2021
@szarnyasg szarnyasg deleted the anchors branch December 4, 2021 18:01
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.

None yet

3 participants