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 glossary auto-links #47

Open
ehuss opened this issue Mar 8, 2024 · 1 comment
Open

Support glossary auto-links #47

ehuss opened this issue Mar 8, 2024 · 1 comment
Labels
C-tooling Category: Discussion/Changes related to custom mdbook tooling

Comments

@ehuss
Copy link
Contributor

ehuss commented Mar 8, 2024

It would be nice to make it easier to link to the glossary.

Ferrocene has ferrocene_autoglossary which gathers the list of terms in the glossary, and then automatically creates links whenever those terms appear in the text. It also checks for glossary terms that are not mentioned anywhere.

I'm uncertain if that is how we want it to work, but seems worth exploring.

@ehuss ehuss added the C-tooling Category: Discussion/Changes related to custom mdbook tooling label Mar 8, 2024
@mattheww
Copy link

mattheww commented Mar 8, 2024

bikeshed might be another source of inspiration. They have the most powerful linking system I've come across in a markdown-based system.

In particular they support reverse links ("referenced in" blocks), which I think can be very useful if you're trying to understand a spec. See here for example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-tooling Category: Discussion/Changes related to custom mdbook tooling
Development

No branches or pull requests

2 participants