google/comprehensive-rust

Cleaner URLs

Open

#1 227 ouverte le 21 sept. 2023

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Rust (32 954 stars) (2 009 forks)batch import
good first issuehelp wanted

Description

See if we can make https://github.com/rust-lang/mdBook/issues/1563 happen somehow. There are several options for this:

  • Help upstream implement this (preferred)
  • Implement it ourselves by post-processing the generated HTML.

Post-processing the HTML could perhaps even be done using a new template engine (https://github.com/google/mdbook-i18n-helpers/issues/70). It would require us to assign the rendered Markdown ({{{ content }}} in handlebars) to a variable or block and then filter it somehow.

Guide contributeur

Stack technique
rust
Domaine
documentation
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
needs investigation
Prérequis
Rust basicsmdBook knowledge
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
35
Direction de recherche
Investigate upstream issue rust lang/mdBook#1563 for cleaner URL support. If not feasible, explore post processing generated HTML using a template engine like discussed in google/mdbook i18n helpers#70. The goal is to modify the build pipeline to transform the rendered content ( content variable in Handlebars) to produce cleaner URLs. Check the mdBook documentation and the repository's build scripts to understand the current URL structure.