mdBook
codebraid
Our great sponsors
| mdBook | codebraid | |
|---|---|---|
| 100 | 4 | |
| 16,617 | 361 | |
| 2.5% | - | |
| 8.7 | 5.2 | |
| 6 days ago | 6 months ago | |
| Rust | Python | |
| Mozilla Public License 2.0 | BSD 3-clause "New" or "Revised" 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
codebraid
-
Literate DevOps
If you want Markdown instead of Org Mode, Codebraid is great.
https://github.com/gpoore/codebraid
-
[D] 7 years since Norm Matloff's blog post "STATISTICS: LOSING GROUND TO CS, LOSING IMAGE AMONG STUDENTS". How has the statistics vs CS situation evolved?
Fortunately, literate programming is a thing, so there are still tools for that. If you want PDF/HTML output facilities, it looks like CodeBraid is the way to go. It uses the Pandoc framework, so you can do all kinds of neat things with it.
-
R Markdown: The Definitive Guide
For the Python in markdown case, you might be interested in one of my projects that allows executable Python code (including optional Jupyter kernel support) in Pandoc markdown: https://github.com/gpoore/codebraid. Pandoc does all the document parsing (there is no regex preprocessor for extracting code), so converting markdown to markdown often works particularly well.
-
How I use Pandoc to create programming eBooks
A tool that really helped me was codebraid, it allows me to keep the code and output of said code in sync really easily.
What are some alternatives?
gitbook - The open source frontend for GitBook doc sites
rmarkdown - Dynamic Documents for R
MkDocs - Project documentation with Markdown.
jupytext - Jupyter Notebooks as Markdown Documents, Julia, Python or R scripts
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
Pluto.jl - 🎈 Simple reactive notebooks for Julia
bookdown - Authoring Books and Technical Documents with R Markdown
Neptune.jl - Simple (Pluto-based) non-reactive notebooks for Julia
obsidian-releases - Community plugins list, theme list, and releases of Obsidian.
gedit-plugin-markdown_preview - A gedit plugin previewing markdown (.md) documents
Docusaurus - Easy to maintain open source documentation websites.
bert - TensorFlow code and pre-trained models for BERT