google/comprehensive-rust

Cleaner URLs

Open

#1,227 建立於 2023年9月21日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Rust (32,954 star) (2,009 fork)batch import
good first issuehelp wanted

描述

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.

貢獻者指南

技術棧
rust
領域
documentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
needs investigation
前置要求
Rust basicsmdBook knowledge
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
35
研究方向
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.