pulldown-cmark
doctave
pulldown-cmark | doctave | |
---|---|---|
8 | 13 | |
1,930 | 521 | |
1.6% | 0.0% | |
9.0 | 0.0 | |
9 days ago | over 1 year ago | |
Rust | Rust | |
MIT License | 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.
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:
doctave
-
After looking around for better note apps briefly, I came back with a new theme instead
(For an example of a site generated by the open source Doctave docs site generator, you can take a look at its own docs.)
-
Doctave 0.4 | Documentation site generator
Doctave Documentation (self-hosted, obviously) Broken links docs Math notation docs
- Doctave: a batteries-included docs site generator
-
Wikis don't work for software documentation
Secondly, you have to think about search. If you use a documentation site generator to turn your Markdown docs into HTML sites, even if the toolchain builds a search index for the site, you will end up with N disconnected sites for N projects. Doctave.com can help with this if you are using our open source documentation site generator.
-
Doctave CLI 0.2.0: A Benchmarking Story
Finally, do try out Doctave 0.2.0! If you're looking for a batteries-included documentation generator that doesn't require plugins, doesn't pollute your repository with loads of files, and doesn't need a specialized environment to run, Doctave may be a good choice for you. It also comes with Mermaid JS diagram support and dark mode!
-
Using Rust with Elixir for code reuse and performance
Reuse code from our open source documentation generator CLI that is built in Rust
-
Any recommendations on a good tool for documentation?
I'm not sure specifically what you're looking for but perhaps consider this: https://github.com/Doctave/doctave The main site: https://www.doctave.com/
-
Doctave: a batteries-included documentation site generator
We have a backlog of features and tweaks we are working on for Doctave. I’d love to hear your feedback, so if you give Doctave a spin, let me know what you think! You can reach out to me directly on Twitter or open an issue on GitHub.
What are some alternatives?
mdBook - Create book from markdown files. Like Gitbook but implemented in Rust
elasticlunr.js - Based on lunr.js, but more flexible and customized.
nimler - Erlang/Elixir NIFs in Nim
docuowl - 🦉 A documentation generator
cmark - CommonMark parsing and rendering library and program in C
Docusaurus - Easy to maintain open source documentation websites.
rust - Empowering everyone to build reliable and efficient software.
Elixir - Elixir is a dynamic, functional language for building scalable and maintainable applications
cmark - 💧 Elixir NIF for cmark (C), a parser library following the CommonMark spec, a compatible implementation of Markdown.
earmark - Markdown parser for Elixir
MkDocs - Project documentation with Markdown.