patricoferris / hilite

Hilite - a simple code to HTML syntax highlighter

Hilite 🎨

A small library that generates HTML ready for syntax-highlighting with CSS by parsing markdown documents.

Currently only some OCaml-related syntaxes are supported directly. For example the test.md file can be converted with:

# Cmarkit.Doc.of_string (read_file "test/test.md")
  |> Hilite_markdown.transform
  |> Cmarkit_html.of_doc ~safe:false;;
- : string =
"<p>&quot;Hello World!&quot; in OCaml looks like:</p>\n<pre><code><span class='ocaml-keyword-other'>let</span><span class='ocaml-source'> </span><span class='ocaml-constant-language-unit'>()</span><span class='ocaml-source'> </span><span class='ocaml-keyword-operator'>=</span><span class='ocaml-sourc"... (* string length 609; truncated *)

Customisation

Hilite supports users loading their own grammars so they can do custom, build-time syntax highlighting. Users most provided a collection of textmate grammars to the transformation function.

Here we will use a predefined grammar that comes along with the Hilite library.

# let tm =
    let t = TmLanguage.create () in
    let grammar = TmLanguage.of_yojson_exn Hilite.Grammars.diff in
    TmLanguage.add_grammar t grammar;
    t
val tm : TmLanguage.t = <abstr>

With this we can now highlight code blocks that start with diff.

# Cmarkit.Doc.of_string (read_file "test/test_diff.md")
  |> Hilite_markdown.transform ~lookup_method:`Filetype ~tm
  |> Cmarkit_html.of_doc ~safe:false;;
- : string =
"<p>A diff block!</p>\n<pre><code><span class='patch-punctuation-definition-deleted'>-</span><span class='patch-markup-deleted'>  module Sel = (val if is_osx () then (module Mac)\n</span><span class='patch-punctuation-definition-deleted'>-</span><span class='patch-markup-deleted'>                    e"... (* string length 1176; truncated *)

This example also shows a use off lookup_method to change how TmLanguage finds the grammar based on the code block infostring.

hilite's Issues

Render highlighted source code as Tyxml

Maybe in another package since it means adding a dependency

Release on opam

Hi 🙂

As I'm working on upstreaming the dependencies we use for https://github.com/ocaml/ocaml.org, I was wondering if we could release hilite on opam?

It's been in use for some time now to generate the content of https://v3.ocaml.org/, and looks stable. What do you think?

Let me know if I can help with anything!

Cmarkit branch not rederering content

Hi @patricoferris thank you for this amazing tool 😊
I tried to pin and use the cmarkit branch of hilite here on ocaml.org. but it doesn't render the contents passed through it. Do you have any pointers on how I can use this?

Here is how I try to use it:
https://github.com/ocaml/ocaml.org/blob/c7fb5b0de75f37d325f9c8a4846dc8c6c81e65d1/tool/ood-gen/lib/changelog.ml#L25-L46

Here is the behavior I'm experiencing:

Before

After

Enabling external syntax support and maybe package splitting

Hello! This is a very interesting project, particularly in the world of static site generators, and it would make it easy to do without highlightjs to support the syntax highlighting. But at the moment, I find the package a little too opionated (to be easily usable generically). But I'm not sure what level of maintenance you assign to this package.

Would it be possible to:

• Propose a core library without dependence on Cmarkit and a hilite_cmarkit library which would act as glue with cmarkit.
• Allow, at the level of library use, a way to provision your own syntaxes (so as not to depend on hilite release for support of alternative syntaxes)?

Thank you in advance for your response and anyway, thank you very much for this superb library!