GithubMarkdown.jl

Author pfitzseb
Popularity
4 Stars
Updated Last
1 Year Ago
Started In
October 2019

GithubMarkdown.jl

Build Status Codecov

Render a markdown file (conforming to the gfm spec) to an IOBuffer or directly to a file.

rendergfm(fileout::AbstractString, file::AbstractString; documenter = false, format="html")
rendergfm(io, file::AbstractString; documenter = false, format="html")

Render the markdown document file to fileout or io, following the cmark-gfm spec.

  • documenter: Wraps the output in a Documenter @raw-block of the specified format.
  • format: Can be one of html, xml, man, commonmark, plaintext, latex.

You can also use rendergfm to work with strings directly:

julia> "a **b** c `def` [g](https://julialang.org)" |> rendergfm
"<p>a <strong>b</strong> c <code>def</code> <a href=\"https://julialang.org\">g</a></p>\n"

Required Packages

Used By Packages