mdBook
patterns
| mdBook | patterns | |
|---|---|---|
| 101 | 63 | |
| 16,754 | 7,699 | |
| 2.0% | 1.1% | |
| 8.6 | 7.5 | |
| 6 days ago | 10 days ago | |
| Rust | Handlebars | |
| Mozilla Public License 2.0 | Mozilla Public License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
mdBook
- Everything Curl
- Doks – Build a Docs Site
-
Ask HN: How do you organize software documentation at work?
I'm responsible for a number of Java products. I try to provide high-quality Javadoc for all public library interfaces, library user's guides where appropriate, and development guides for applications. The latter two take the form of MDBook documents (https://rust-lang.github.io/mdBook/), with the document source living in the GitHub repo so that it's tied to the particular software release in a natural way.
-
Outline: Self hostable, realtime, Markdown compatible knowledge base
My org has used mdBook: https://rust-lang.github.io/mdBook/ (That link is itself a rendered mdBook, so that'll give you an idea of the feature set.)
(While it's definitely a Rust "thing", if you just have a set of .md files, all you need is a "SUMMARY.md" (which contains the ToC) and a small config file; i.e., you don't have to have any Rust code to use it, and it works fine without. We document a large, mostly non-Rust codebase with it.)
-
Ask HN: Best tools for self-authoring books in 2023?
If you want the lowest friction, open source, easily extensible Markdown to Web, Kindle, PDF, etc. tool, highly recommend mdBook: https://github.com/rust-lang/mdBook it’s written in Rust, but you don’t have to know any Rust to use it. And then wing is all CSS; for which there are many good (free) themes.
- Early performance results from the prototype CHERI ARM Morello microarchitecture
- FLaNK Stack for 4th of July
- MdBook – A command line tool to create books with Markdown
- MdBook Create book from Markdown files. Like Gitbook but implemented in Rust
patterns
- Best practices for designing traits in public crates?
-
Ask HN: Learning new coding patterns – how to start?
For OOP design patterns in Rust, see: https://rust-unofficial.github.io/patterns/
For a book on FP, see: https://www.manning.com/books/grokking-simplicity
- Haskell mini-patterns handbook (2020)
- Is there any site with Dos and Don'ts in Rust?
-
Functional Options Pattern in Go and Rust
Just wanting to let this here for some further input: - https://rust-lang.github.io/api-guidelines/ - https://rust-unofficial.github.io/patterns/ - https://deterministic.space/elegant-apis-in-rust.html
-
Rust exercices for tech interview
Rust Design Patterns
-
I want some help learning design patterns
I know about Rust Design Pattern what are your reviews for the same?
-
I've been writing C# for nearly a decade, but I want to learn how to build programs with Rust. What do I need to change about how I structure my code?
Once you've finished with The Book and possibly Programming Rust, 2nd Edition if you've got the cash for a paid book, read Learning Rust With Entirely Too Many Linked Lists (it helps to solidify what ownership and borrowing mean for data structures) and Rust Design Patterns.
-
Is there a coding style and set of best-practices that avoid (not bypass) "fighting the borrow checker"?
Well, there's https://rust-unofficial.github.io/patterns/ for a start.
-
Comprehensive Rust 🦀 is now available in Korean!
Love the translation pipeline, currently looking into adopting that as well for the Rust patterns book!
What are some alternatives?
gitbook - The open source frontend for GitBook doc sites
nomicon - The Dark Arts of Advanced and Unsafe Rust Programming
MkDocs - Project documentation with Markdown.
rust-typed-builder - Compile-time type-checked builder derive
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
too-many-lists - Learn Rust by writing Entirely Too Many linked lists
bookdown - Authoring Books and Technical Documents with R Markdown
book - The Rust Programming Language
obsidian-releases - Community plugins list, theme list, and releases of Obsidian.
idiomatic-rust - 🦀 A peer-reviewed collection of articles/talks/repos which teach concise, idiomatic Rust.
Docusaurus - Easy to maintain open source documentation websites.
vulkano - Safe and rich Rust wrapper around the Vulkan API