Indeed. The HTML is always the same, only the CSS changes, so I definitely could do it. I have chosen not to paste the same code many times precisely because it serves as a good benchmark for Makeup.
Currently it’s rendering ~120 code blocks in 2-4s. For real projects, there might be some oportunities to parallelize it, but I don’t know if that’s something I should handle in makeup core…
Another example of Makeup’s output: the official elixir docs highlighted by Makeup instead of Highlight.js: API Reference – elixir v1.7.0-rc.0.
For an example of actual code being highlighted, see here: Agent – elixir v1.7.0-rc.0
It also highlights the iex prompt correctly: Calendar.ISO – elixir v1.7.0-rc.0, so it now doubles as an iex lexer.
You can’t try this at home yet because it still depends on an unreleased package and on manually editing the minified javascript returned by ExDoc to play well with my own javascript.
EDIT: the CSS stylefor the highlighted code is not the same. I didn’t try to port the highlightjs stylesheet, and I don’t think I should because my own style is richer and shows more distinctions between identifiers. The them is my new “Samba” theme, which is a patched version of the Pygments “Tango” style to render module names in a different color from variable names and play better with the rest of the ExDocs theme.
Very nice, but scroll down on any of those links all the way and click “Switch to night mode” at the very bottom, something is not working well there. ^.^;
Nice catch! I have to find out how that night mode thing works and add a new theme that’s more readable during the night mode
Ok, big news:
There is now a library, Makedown, which is basically Earmark with a custom code rendering function that uses Makeup.
ExDoc master (still unreleased) is now compatible with Makedown. You can’t use it yet to document hex packages because Hex doesn’t accept dependencies from GitHub, even if they are dev-only and have no impact on runtime (should this be changed?)
You can now clone my demo and build it locally: (it will take a long time to compile because of Makeup but the rendering part is quick)
There is a new style that plays well with night mode (maybe a little too colorful, but very readable with the dark colors)
A new version of ExDoc has been released. This version (0.16.3) supports using Makedown (a markdown implementation that uses Makeup) as the markdown processor. Instructions on how to integrate here:
https://github.com/tmbb/makedown#integration-with-exdoc
This means you can now use Makeup as the syntax highlighting library for the hexdocs documentation of your packages.
Hmm, I should use it in SpiritEx to complete the circle, I wonder if it would let me have a circular dependency like that… Have a library depend on a library that depends on the first library, yeah it should work if the API is the same I think then. ^.^
Just tried it. It doesn’t work… ExSpirit is downloaded as a dependency and you get conflicts. You can probably hack your way around it but it won’t work when uploading the documentation to hexdocs… You can add it to other packages, thoug.
I’m going to try it on some of your packages and submit a PR. Not necessarily today.
If it works, I should write a bot that crawls hex.pm, adds the config options to use makedown to all elixir packages and submit a PR to GitHub xD
