google/comprehensive-rust

Cleaner URLs

Open

#1,227 opened on 2023年9月21日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Rust (32,954 stars) (2,009 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.
Cleaner URLs · google/comprehensive-rust#1227 | Good First Issue