Skip to content

docs: improve upstream md-book code snippets display #388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
iqdecay opened this issue Jun 13, 2022 · 0 comments
Open

docs: improve upstream md-book code snippets display #388

iqdecay opened this issue Jun 13, 2022 · 0 comments
Assignees
Labels
blocked enhancement New feature or request good first issue Good for newcomers

Comments

@iqdecay
Copy link
Contributor

iqdecay commented Jun 13, 2022

  • 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 rust-lang/mdBook#1601 would solve this! It would also be of benefit for all books!

Tagging @mitchmindtree for tooling consideration 😄

@iqdecay iqdecay added enhancement New feature or request good first issue Good for newcomers labels Jun 13, 2022
@adlerjohn adlerjohn moved this to Todo in Fuel Network Jun 13, 2022
@Salka1988 Salka1988 self-assigned this Jul 12, 2022
@Salka1988 Salka1988 added blocked good first issue Good for newcomers and removed good first issue Good for newcomers labels Jul 18, 2022
@digorithm digorithm removed this from Fuel Network Sep 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants