google/comprehensive-rust

Cleaner URLs

Open

#1.227 geöffnet am 21. Sept. 2023

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (32.954 Stars) (2.009 Forks)batch import
good first issuehelp wanted

Beschreibung

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.

Contributor Guide

Tech Stack
rust
Domain
documentation
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
needs investigation
Voraussetzungen
Rust basicsmdBook knowledge
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
35
Research-Richtung
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.