mdBook
iota
Our great sponsors
mdBook | iota | |
---|---|---|
100 | 3 | |
16,564 | 1,608 | |
2.2% | - | |
8.7 | 0.0 | |
7 days ago | over 1 year ago | |
Rust | Rust | |
Mozilla Public License 2.0 | MIT License |
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
- 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.
- FLaNK Stack for 4th of July
-
MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
Interesting enough there seems to be an open PR for that: https://github.com/rust-lang/mdBook/pull/1918
- Effective Rust
-
is it possible to read books in vim?
If you are interested to draw something I also suggest you to use mdbook
- Super unpopular opinion incoming.
iota
- Micro – A Modern Alternative to Nano
-
CPU May Have Slowed Down on Wednesday
> but I'm sure it won't be able to open a 1KB text file instantaneously in 5 years
Unless you decide to switch to a modern console-based text editor. It doesn't have to be vim or emacs. There are many other alternatives. One new such editor written-in-Rust being Iota: https://github.com/gchp/iota
What are some alternatives?
gitbook - The open source frontend for GitBook doc sites
MkDocs - Project documentation with Markdown.
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
bookdown - Authoring Books and Technical Documents with R Markdown
xi-editor - A modern editor with a backend written in Rust.
obsidian-releases - Community plugins list, theme list, and releases of Obsidian.
Docusaurus - Easy to maintain open source documentation websites.
notty - A new kind of terminal
rubigo
nomicon - The Dark Arts of Advanced and Unsafe Rust Programming
rust-doom - A Doom Renderer written in Rust.
obsidian-git - Backup your Obsidian.md vault with git