Add structured data to generated pages · google/comprehensive-rust

(1 commentaire) (0 réaction) (0 personne assignée)Rust (2 009 forks)batch import

enhancementgood first issuehelp wanted

Métriques du dépôt

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

I imagine this could be metadata about each page:

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.

Direction de recherche: Explorez les préprocesseurs mdbook existants pour comprendre l'API et comment injecter du JSON LD dans le HTML généré. Consultez la documentation de mdbook pour créer des préprocesseurs personnalisés. Prenez en compte les types spécifiques de données structurées mentionnés : Breadcrumb, Course, SitelinksSearchBox. Testez avec un préprocesseur simple qui ajoute un bloc JSON LD statique pour vérifier que le pipeline fonctionne, puis implémentez l'extraction dynamique des données (par exemple, hiérarchie des pages, date de dernière modification depuis Git). L'issue a un commentaire qui pourrait fournir des conseils supplémentaires.
Stack technique: rust
Domaine: documentation
Type d'issue: Fonctionnalité
Difficulté: 3
Temps estimé: 3-5 jours
Statut d'activité: Active
Clarté: Plutôt claire
Prérequis: Rustmdbook
Accessibilité débutant: 50