mdBook
comprehensive-rust
| mdBook | comprehensive-rust | |
|---|---|---|
| 101 | 32 | |
| 16,754 | 26,092 | |
| 2.0% | 4.5% | |
| 8.6 | 9.8 | |
| 6 days ago | 2 days ago | |
| Rust | Rust | |
| 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
- 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
comprehensive-rust
- Comprehensive Rust V2
-
Scaling Rust Adoption Through Training
Thanks! We do include speaker notes on some pages (but not yet all[1]). We would love to expand this and PRs are very welcome for this :-)
I think videos will end up being made by someone other than me since I feel it takes too much effort when you don't have the right setup already. We have an issue and I'll update it as soon as I hear more about videos.[2]
[1]: https://github.com/google/comprehensive-rust/issues/1083
A bit more detail: we've been expanding our Rust training at Google over the last year. We've now had more than 500 Googlers go through Comprehensive Rust and they tell us that they really like it — also when we ask them again three months later :-)
The post is a huge Thank You! to the many people who have helped with the course, both inside and outside of Google. More than 30 Googlers (who already knew Rust) have picked up the course and taught it around the world.
People have used the material for [university classes](https://mo8it.com/blog/teaching-rust/) and there will soon be [online classes](https://twitter.com/mrtngslr/status/1696601520412783052) as well. I hope it will become a good resource for people to teach Rust in many different contexts!
Pull requests are always welcome, the whole thing is open source: https://github.com/google/comprehensive-rust/.
-
Any open source projects willing to take in juniors?
Yes, I would love to have more contributors to https://github.com/google/comprehensive-rust and https://github.com/google/mdbook-i18n-helpers!
- Comprehensive Rust: course used by the Android team at Google
- GitHub - google/comprehensive-rust: This is the Rust course used by the Android team at Google. It provides you the material to quickly teach Rust to everyone.
- The Rust course used by the Android team at Google
-
google developed course on Rust
That's done with a bit of JavaScript. It's not super elegant... I would love to have someone with current JavaScript skills improve it :D
What are some alternatives?
gitbook - The open source frontend for GitBook doc sites
book - The Rust Programming Language
MkDocs - Project documentation with Markdown.
mdbook-i18n-helpers - Translation support for mdbook. The plugins here give you a structured way to maintain a translated book.
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
k8s-openapi - Rust definitions of the resource types in the Kubernetes client API
bookdown - Authoring Books and Technical Documents with R Markdown
teach-rs - A modular, reusable university course for Rust
obsidian-releases - Community plugins list, theme list, and releases of Obsidian.
velo - App for brainstorming & sharing ideas 🦀 Learning Project
Docusaurus - Easy to maintain open source documentation websites.
paat