Comments (4)
Formatted the code blocks with dprint
and I'm happy with that. Going to close this here. :) Thanks again for that awesome recommendation. Made my life a lot easier in different repositories. 👍🏽
from patterns.
I've thought a bit about this for https://github.com/google/comprehensive-rust :-) In general, moving code snippets from the Markdown file to .rs
files makes it harder to understand the book itself. However, having .rs
files comes with advantages in terms of editor support (syntax highlighting) and formatting, etc.
format
and
For this, I plan to use dprint.dev which will format code snippets inside Markdown files.
test
code in this book.
I haven't checked what kind of code you typically have in your examples, but mdbook test
works pretty well for us. I'm also planning to take a closer look at mdbook-keeper: https://github.com/tfpk/mdbook-keeper/.
from patterns.
Oh, dprint
is a nice tool, thanks for the recommendation. So do I understand you right, that you would advise us against extracting the code examples, because the only benefits would be editor support? And as you wrote in the other issue, that it would make translations "fuzzy" if more than paragraphs changed?
from patterns.
So do I understand you right, that you would advise us against extracting the code examples, because the only benefits would be editor support?
I've been working in a special constrained environment because I'm trying to fit everything on a page without scrolling — I'm (mis)using mdbook to make a presentation, essentially. Because of this my code snippets are short, 5-10 lines typically. The overhead of managing an extra file was typically higher than the advantage for me.
And as you wrote in the other issue, that it would make translations "fuzzy" if more than paragraphs changed?
The fuzzyness is on a per-message basis. It's not affected by where you put the code: mdbook-i18n-helpers gives you a preprocessor and if you run it after the built-in links
preprocessor, then it sees the code after resolving any {{#include
directives. If you run it before, it will see the directive.
from patterns.
Related Issues (20)
- Floating Point Related Idioms HOT 1
- Add double panic mentioning for RAII guards HOT 1
- Clarify parts of Lenses and Prisms chapter HOT 11
- Borrow Checker Patterns HOT 2
- Clarify paragraph in Generics as Type Classes
- Clarify naming convention of `build()` in section 3.2.1 HOT 1
- Design Patterns, Strategy has unclear identifier `Context` and `run` mentioned. HOT 1
- View type
- Translations HOT 6
- Incorrect text in Command pattern description
- Translation: Persian HOT 5
- Is this example wrong ? HOT 1
- Printing the book should not inherit theme colours HOT 1
- Translate: Vietnamese HOT 2
- Typo in idioms/coercion-arguments.md HOT 3
- Add pdf renderer and link rendered book
- Consistent Headline Capitalization? HOT 1
- Incompatible definition of Mutex::lock (or MutexGuard)
- Foo Bar (ad nauseam)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from patterns.