FuelLabs/fuels-rs

docs: improve upstream `md-book` code snippets display

Open

#388 创建于 2022年6月13日

在 GitHub 查看
 (0 评论) (1 反应) (1 负责人)Rust (43,211 star) (1,360 fork)batch import
blockedenhancementgood first issue

描述

  • We now want all code that goes in the book to be tested (and put in the examples directory), so all code in The Book will soon be put there using the {{include path/to/file}} tag of md-book.

Problem: the formatting isn 't very nice, there's extra identation displayed because the code is inside a test function.

Fixing https://github.com/rust-lang/mdBook/issues/1601 would solve this! It would also be of benefit for all books!

Tagging @mitchmindtree for tooling consideration :smile:

贡献者指南

技术栈
rust
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
blocked
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Rust basicsmdBookHTML/CSS fundamentals
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
Investigate the linked upstream issue (rust lang/mdBook#1601) to understand the proposed fix for code snippet indentation. Explore the `examples` directory in fuels rs and the mdBook configuration files (e.g., book.toml) to see how the include macro is currently used. Implement a workaround or contribute to the upstream fix to strip extra indentation from included code snippets. Check the assignee's comments for any prior work or direction.