asaaki/cmark.ex

💧 Elixir NIF for cmark (C), a parser library following the CommonMark spec, a compatible implementation of Markdown.

Hi there! 👋🏻

• 🦀 I love Rust. Use it as a hobbyist, but work would be cool.
• 💎 I (mainly) work with Ruby, JavaScript, and TypeScript.
• 🐳 I use Docker and Kubernetes.
• 🌍 I terraform that on AWS.
• 👪 I'm glue. I help and enable and unblock teams.
• ✍🏻 I blog about stuff at markentier.tech

cmark.ex's Issues

Code Highlighting

I haven't used the Cmark parser before with ExDoc but I tried it because Earmark doesn't support formatting markdown nested inside html tags. Cmark does, but my output has no code highlighting.

Is this expected?

All I've done is add {:cmark, "~> 0.7"} to my deps, add markdown_processor: ExDoc.Markdown.Cmark, and build the docs. You can see the result below:

I'm happy to provide additional information if it's helpful!

Thanks

Adding templates for PR / Issues and CoC

If this repository gets more attention, should we add a template for

• Issues
• Pull Requests

and a Code of Conduct? For the sake of simplicity, I'd just use either one of:

• https://github.com/stevemao/github-issue-templates
• or the issue template from elixir with the appropriate modifications

The Code of Conduct can be created via Github itself.

Does not compile on Windows

==> cmark
could not compile dependency :cmark, "mix compile" failed. You can recompile this dependency with "mix deps.compile cmark", update it with "mix deps.update cmark" or clean it with "mix deps.clean cmark"
** (ErlangError) Erlang error: :enoent
    (elixir) lib/system.ex:605: System.cmd("make", [], [stderr_to_stdout: true])

OS: Win10
c compilers installed: VS 2015, clang 4.0
shells tried: git bash, powershell, Developer Command Prompt for VS2015 after running vcvarsall.bat
other notes: both Cmake and Nmake are installed, compiling bcrypt and other NIFs doesn't fail

Support for cmark-gfm?

Hello!

I'm looking for a NIF for GitHub Flavored Markdown version of cmark. Would it be possible for this library to support it?
Or it should sit on a separate repo?

I'm happy to contribute, even though I'm totally noob on the subject :)

Thanks

Released 0.6.8 version does not have :safe working

Appears a 0.6.9 needs to be released?

Add a changelog for cmark releases

First of all, thank you for your great library!

It would be great if cmark.ex kept a changelog of each release, so consumers can easily find what changed.

fenced code blocks still have "```" in the html

hi @asaaki,

Cmark.to_html("```\nTEST\n```")
=> "<pre><code>TEST\n```</code></pre>\n"

I think the "```" in the returned HTML shouldn't be there. If i run cmark from the command line with the same input I get

<pre><code>TEST
</code></pre>

which looks better.

I tried updating the c_src, but I didn't know how to get the .h files from the .h.in files in the cmark repo. I'm also not 100% sure it's a bug in the c code, as I checked out a version of cmark from may and that produced the correct HTML.

Fresh paint for the old house 🎨🏚

There seem to be still some users out there.
Sadly they have to deal with this relatively unmaintained project.
We should update it a bit.

TODOs:

• update the C library
• check if code is still suitable for modern Elixir

Given that it's about C and NIFs also sadly not a very beginner friendly task.

Use bindings for cmark-gfm instead

Folks, what do you think about replacing the bindings for cmark-gfm instead?

It has some extensions, like tables, which we could leave disabled by default. This means we get the commonmark behaviour but there is some extra functionality if someone wants to opt-in?

Release new version?

Would it be possible to release a new version with the changes since 0.6.10? Thanks! :)

A way to white list safe tags when using to_safe_html

Hi,

Right now if you use to_safe_html, it will strip out image tags but imagine a scenario where you're creating a comment box similar to GitHub issues where you want to allow users to upload images.

It would be nice if to_safe_html allowed you to set a list of allowed tags.