cmark VS ripgrep

I use GNU make. Write content in markdown, feed it to https://github.com/commonmark/cmark to create html. I intended to splice files together using xslt but echo and cat written in the makefile sufficed.

I'm not totally sure I'd recommend that but I do like the markdown => html flow.

I seem to be in the middle of trying to build something similar to this. I want it to run on an android phone but otherwise the same sort of idea, offline-first information I want access to.

There's some weirdness around android browsers refusing to load html from the phone itself on security grounds. The OP uses a "progressive web app" which seems to be the proper way to do this at some point in the past, but firefox has killed that for some reason. Thus the most difficult part of the project seems to be persuading my phone to render html without copying the files to some server (or running a fileserver on the phone itself, to look at from the phone, which seems absurd).

What I can offer for people stumbling down the same path:

- Obsidian works fine as for ad hoc authoring of markdown while walking around

- It is known on stack overflow that markdown can't be sanely parsed into an AST

- That knowledge is kind of a branding misfire, the 'markdown' one is looking for is here https://github.com/commonmark/cmark

- That cmark binary + some foreach-file style script will turn markdown into html or xml. If you choose makefile and put spaces in the name of files you'll have a moderately bad few minutes cursing your tools

- Given that output xml/html, you can build whatever other html you see fit

- That html can be written back to the obsidian vault and opened by a phone browser (at least if it's a single file)

- CSS thus far appears to be required, I was really hoping to annotate the html instead

First 90% done here, second 90% to go.

Yeah no doubt it, although in this case the C implementation has been a long running project that's under the official commonmark GitHub repo at https://github.com/commonmark/cmark.

But I think the most important thing here is an Elixir NIF already exists to use it. The blog post as is leaves readers having to implement ~100 lines of Elixir code to use the Rust version because the authors of blog post didn't include that in the article, or open source it as a library for others to use.

So from a reader's POV, if your goal is to get a highly stable, fast and safe Markdown parser running in Elixir, the Elixir cmark library I linked in a parent comment solves that problem out of the box.

I'm confused about how to use a c library (specifically, cmark) from zig.

Writing Documents Markdown (and md2pdf or cmark + html2ps + ps2pdf) / plain text / groff

It's built on top of cmark which make it fast, and use pure markdown without any proprietary format. It currently supports both macOS and iOS.

However, writing a proper markdown parser is quite difficult as you have to support nesting and many weird corner cases. So, if you do not need to write your own parser (e.g. for learning purposes), it would be a lot easier to use an existing parser and write a custom renderer for roff. Some such parsers are cmark, commonmark.js, and goldmark.

I just use the small reference C implementation of CommonMark and it works great:

https://github.com/commonmark/cmark

There is an example where you load it via shared library in Python, i.e. send a Markdown string and get back an HTML string.

ripgrep - https://github.com/BurntSushi/ripgrep

Basic code searching skills seems like something new developers are never explicitly taught, but which is an absolutely crucial skill to build early on.

I guess the knowledge progression I would recommend would look something kind this:

- Learning about Ctrl+F, which works basically everywhere.

- Transitioning to ripgrep https://github.com/BurntSushi/ripgrep - I wouldn't even call this optional, it's truly an incredible and very discoverable tool. Requires keeping a terminal open, but that's a good thing for a newbie!

- Optional, but highly recommended: Learning one of the powerhouse command line editors. Teenage me recommended Emacs; current me recommends vanilla vim, purely because some flavor of it is installed almost everywhere. This is so that you can grep around and edit in the same window.

- In the same vein, moving back from ripgrep and learning about good old fashioned grep, with a few flags rg uses by default: `grep -r` for recursive search, `grep -ri` for case insensitive recursive search, and `grep -ril` for case insensitive recursive "just show me which files this string is found in" search. Some others too, season to taste.

- Finally hitting the wall with what ripgrep can do for you and switching to an actual indexed, dedicated code search tool.

live grep: ripgrep

The world has moved on though to opinionated tools, and Rust isn't even the furthest in that direction (That would be Go). The equivalent of those two lines in Cargo.toml would be this example of a basic configuration from the jacoco-maven-plugin: https://www.jacoco.org/jacoco/trunk/doc/examples/build/pom.x... - That's 40 lines in the section to do the "defaults".

Yes, you could add a load of config for files to include/exclude from coverage and so on, but the idea that that's a norm is way more common in Java projects than other languages. Like here's some example Cargo.toml files from complicated Rust projects:

Servo: https://github.com/servo/servo/blob/main/Cargo.toml

rust-gdext: https://github.com/godot-rust/gdext/blob/master/godot-core/C...

ripgrep: https://github.com/BurntSushi/ripgrep/blob/master/Cargo.toml

socketio: https://github.com/1c3t3a/rust-socketio/blob/main/socketio/C...

I'm not clear on why you're seeing the results you are. It could be because your haystack is so small that you're mostly just measuring noise. ripgrep 14 did introduce some optimizations in workloads like this by reducing match overhead, but I don't think it's anything huge in this case. (And I just tried ripgrep 13 on the same commands above and the timings are similar if a tiny bit slower.)

[1]: https://github.com/radare/ired

[2]: https://github.com/BurntSushi/ripgrep/discussions/2597

Explore o Ripgrep no repositório oficial: https://github.com/BurntSushi/ripgrep

🔎🗃️ ripgrep or ugrep (search fast, use regex patterns or fuzzy search, pipe output to bash/zsh shell for further processing V coloring)