mdBook
nomicon
Our great sponsors
mdBook | nomicon | |
---|---|---|
76 | 63 | |
12,311 | 1,277 | |
6.3% | 3.4% | |
8.2 | 6.4 | |
9 days ago | 11 days ago | |
Rust | CSS | |
Mozilla Public License 2.0 | Apache 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
-
I made a browser extension that automatically applies themes on websites generated with mdBook.
I personally had the frustration that websites generated with [mdBook](https://github.com/rust-lang/mdBook) always displayed me the "Navy" theme. But I prefer the "Ayu" theme, therefore I always set the theme to "Ayu". But doing things per hand is not the way we do stuff around here, so I decided to write a small browser extension that applies the themes for me.
-
Are books underrated as a source for learning?
It's mdBook which is made in Rust and popular with Rust content https://rust-lang.github.io/mdBook/
- Self-hosted/opensource Help Center / CMS?
-
mdbook PDF generator with (optionally) no dependencies
I made a PDF generator for mdbook called mdbook-compress.
-
How to improve documentation / technical writing skills?
This makes me think, maybe I'll start using mdBook. I find it really comfortable to read and it's probably not too complicated to use.
-
Anyone use Git for writing projects?
I sync Obsidian with Git and use pandoc for book / ebook generation (or Foam with Visual Code might work too).
Scrivener can synchronise with Git too - albeit indirectly (it sync's with a folder & I use a simple script to keep it up to date)
If you need to organise research you can sync Wiki.js with Git.
However, Gitbook or mdBook might be easier to use for a single book project.
https://rust-lang.github.io/mdBook/
-
Wiki or a static website for homelab description
mdBook
-
Name a program that doesn't get enough love!
+1 for Pandoc. I'll also add mdBook as an alternate for markdown to web version of ebooks (especially for search and themes).
-
What’s the prettiest yet most lightweight self-hosted wiki service out there?
I also don't mind using a Markdown editor + static site generator like mdBook - BookStack is where I'd have gone if I wanted something else
-
New Rust course by Android: Comprehensive Rust 🦀
All credit goes to the mdbook people for this! I'm using it to turn Markdown text into HTML, complete with interactive playgrounds and all :-)
nomicon
-
What's everyone working on this week (6/2023)?
You should read The Rustonomicon before you use unsafe since it's essentially the unsafe guidelines and covers much more than I can here
-
Stop Comparing Rust to Old C++
Rust doesn't have similar obscure details? May I interest you with the Rustonomicon?
-
Rust from a security perspective, where is it vulnerable?
For more details on this kind of thing, you might be interested in the Rustonomicon, which is the goto guide for the details of writing unsafe Rust code.
The "Rustonomicon" is a book about unsafe code in Rust: https://doc.rust-lang.org/nomicon/
-
Red Black Tree in Rust
Getting into unsafe Rust is generally more for intermediate to advanced users, but the Rustonomicon has good information on how to do it safely: https://doc.rust-lang.org/nomicon/
The hard part is designing a safe "rusty" interface around such data structures, so it actually becomes practical (and safe) to use them in regular Rust code. The best place to look for is the Rustonomicon book. It documents Rust's safety requirements and unsafe code.
-
Anything C can do Rust can do Better
⭐ The Rustonomicon - The Dark Arts of Advanced and Unsafe Rust Programming - repo
-
T̶h̶e̶ ̶m̶o̶s̶t̶ ̶u̶p̶v̶o̶t̶e̶d̶ ̶c̶o̶m̶m̶e̶n̶t̶ ̶p̶i̶c̶k̶s̶ ̶t̶h̶e̶ ̶n̶e̶x̶t̶ ̶l̶i̶n̶e̶ ̶o̶f̶ ̶c̶o̶d̶e̶:̶ ̶D̶a̶y̶ ̶1̶3̶. Refactor time! Rewrite lines 10-12, so their behavior doesn't change. Whoever gets it with the least amount of symbols, wins. You can use multiple lines.
Can confirm. Rust has one of these and the code looks similar: https://doc.rust-lang.org/nomicon/
-
Ask HN: Recommended Rust Resources?
I'll add a (lone?) voice for diving in to the deep end straight away:
https://doc.rust-lang.org/reference/
https://doc.rust-lang.org/nomicon/
Documentation aimed at beginners often assumes a lack of prior programming experience, which is useful if you are (for example) a high-school student learning about pointers and abstraction but IMO not a good use of time for most people posting on Hacker News.
The Rust reference manual is well-written and comprehensive for basic Rust, and the Rustonomicon has often answered my questions about more advanced topics (FFI, concurrency).
What are some alternatives?
gitbook - 📝 Modern documentation format and toolchain using Git and Markdown
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
MkDocs - Project documentation with Markdown.
bookdown - Authoring Books and Technical Documents with R Markdown
book - The Rust Programming Language
notty - A new kind of terminal
iota - A terminal-based text editor written in Rust
funzzy - Yet another fancy watcher. (Rust)
rust-playground - The Rust Playground
rubigo
codebraid - Live code in Pandoc Markdown
Theseus - Theseus is a modern OS written from scratch in Rust that explores 𝐢𝐧𝐭𝐫𝐚𝐥𝐢𝐧𝐠𝐮𝐚𝐥 𝐝𝐞𝐬𝐢𝐠𝐧, novel OS structure, and state management. It strives to close the semantic gap between compiler and hardware to maximally leverage the power of language safety, and thus shift OS responsibilities like resource management into the compiler.