pulldown-cmark
mdBook
pulldown-cmark | mdBook | |
---|---|---|
8 | 101 | |
1,930 | 16,669 | |
1.6% | 1.5% | |
9.0 | 8.6 | |
9 days ago | 15 days ago | |
Rust | Rust | |
MIT License | Mozilla Public 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.
pulldown-cmark
-
CryptoFlow: Building a secure and scalable system with Axum and SvelteKit - Part 3
As a platform that allows expressiveness, we want our users to be bold enough to ask and answer questions with either plain text or some markdowns. Compiling markdown to HTML in Rust can be done via the pulldown-cmark crate. We used it in this utility function:
-
Building a high performance JSON parser
I also really like this paradigm. It’s just that in old crusty null-terminated C style this is really awkward because the input data must be copied or modified. But it’s not an issue when using slices (length and pointer). Unfortunately most of the C standard library and many operating system APIs expect that.
I’ve seen this referred to as a pull parser in a Rust library? (https://github.com/raphlinus/pulldown-cmark)
- Let Rust detect changes in the Markdown file and generate HTML.
-
Show HN: A Graphviz Implementation in Rust
Really glad to see this! Really want an easy way to render graphs in Rust without resorting to the graphiz binary.
What is the current status? Not seeing it listed anywhere, like if there are features that are not supported or if it uses certain layout algorithms but others are desired.
Would you be willing to make a `[lib]` available? I see you have a `lib.rs` but it'd be great if using it didn't require pulling in `[[bin]]` dependencies (you can mark them as optional and mark `required-features` on your bin like pulldown-cmark does [0] or split it into a separate crate in a workspace). It'd also be good to find an available name for the lib and get it published (looks like someone might be squatting on `layout`).
[0] https://github.com/raphlinus/pulldown-cmark/blob/master/Carg...
-
Using Rust with Elixir for code reuse and performance
Author here. I actually was not aware of cmark.ex - thanks for pointing it out.
In this case the code reuse was more important than pure native speed. We already had a Rust library that used pulldown-cmark [1] with some custom tweaks that we wanted to duplicate. Maybe this behavior could have been copied using cmark.ex too (we thought about doing this in pure Elixir, as mentioned in the post), but given how straightforward Rustler made integrating our existing code, this seems like the better choice.
[1] https://github.com/raphlinus/pulldown-cmark
It turned out that making the most popular Elixir Markdown processor, Earmark (originally written by Dave Thomas) and pulldown-cmark, a Rust Markdown processor, produce the same output was going to be difficult. We also required some customization that was not available in both libraries.
-
What are some examples of particularly well written crates?
The crate that's closest to production quality code is pulldown-cmark, but I don't hold it up as an example of well-written code, because it's not particularly easy to understand and there's a lot of very low level code to consume the CommonMark syntax - that helps with code bloat and compile time, but not clarity.
-
What are the Markdown features/extensions enabled in mdbook?
The Markdown processor is pulldown-cmark, which supports these extensions:
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
What are some alternatives?
nimler - Erlang/Elixir NIFs in Nim
gitbook - The open source frontend for GitBook doc sites
doctave - A batteries-included developer documentation site generator
MkDocs - Project documentation with Markdown.
cmark - CommonMark parsing and rendering library and program in C
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
rust - Empowering everyone to build reliable and efficient software.
bookdown - Authoring Books and Technical Documents with R Markdown
cmark - 💧 Elixir NIF for cmark (C), a parser library following the CommonMark spec, a compatible implementation of Markdown.
obsidian-releases - Community plugins list, theme list, and releases of Obsidian.
earmark - Markdown parser for Elixir
Docusaurus - Easy to maintain open source documentation websites.