mdBook
funzzy
Our great sponsors
mdBook | funzzy | |
---|---|---|
100 | 2 | |
16,669 | 220 | |
2.5% | - | |
8.6 | 8.2 | |
9 days ago | 24 days 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.
- 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
-
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
funzzy
-
Alternative for running tests
Why is running on a terminal hassle? Why not use a watcher of some sorts? My solution for that is tmux + a generic watcher like entr or, shamless self plug, https://github.com/cristianoliveira/funzzy
-
Looking for a way to move files automatically based on certain rules/criteria
I've used funzzy which lets you define in yml directories/files to watch and then run arbitrary code (in bash) but I'm not using it on Unraid only on my local machine.
What are some alternatives?
gitbook - The open source frontend for GitBook doc sites
xi-editor - A modern editor with a backend written in Rust.
MkDocs - Project documentation with Markdown.
flowgger - A fast data collector in Rust
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
alacritty - A cross-platform, OpenGL terminal emulator.
bookdown - Authoring Books and Technical Documents with R Markdown
vagga - Vagga is a containerization tool without daemons
obsidian-releases - Community plugins list, theme list, and releases of Obsidian.
imag - imag - Text based personal information management suite
Docusaurus - Easy to maintain open source documentation websites.
config