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.

Sign up for GitHub

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

Jump to bottom

Add structured data to generated pages #1142

Open

mgeisler opened this issue Aug 31, 2023 · 1 comment

Labels

enhancement good first issue help wanted

Collaborator

mgeisler commented Aug 31, 2023 •

edited

Loading

We should look into adding structured data to the generated HTML.

I imagine this could be metadata about each page:

title, though this is probably covered fine with the title element,
when was the page last changed (look this up in Git),
place in the page hierarchy,

It seems there is special vocabulary available which might be interesting for us:

Breadcrumb: to show the parent pages
Course: we might be able to distinguish between Rust Fundamentals, Rust in Android, Bare-Metal Rust, and Concurrency in Rust.
Sitelinks search box: we can perhaps get a search box which leads straight to a mdbook search.

How to do this? Likely with a new mdbook preprocessor which can inject the data into the publishing pipeline.

The text was updated successfully, but these errors were encountered:

mgeisler added enhancement good first issue help wanted labels

Collaborator Author

mgeisler commented Sep 4, 2023

@sakex, a new renderer (google/mdbook-i18n-helpers#70) would probably help with this too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment