mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-11-17 06:38:11 +00:00
There are still quite a few parts of the language that need support here, but I've tried to piece together a decent foundation and address some of the particular challenges with building a good framework that handles some of the complex parts of the grammar such as successfully identifying the declared names in even reasonably complex patterns. I've included a pretty ad-hoc test file I've been using to make sure it works. If folks want a particular testing strategy for this, happy to explore building one although I don't really know what it should look like. Also happy to have suggestions about where this should live in the repository. No strong opinions there. Hoping to eventually add a `tmLanguage` file and any other syntax highlighting systems that are useful. I'll next be finishing off other parts of the language, and then I plan to use this as a component of our presentation material, which is why I'm focused on Highlight.js -- that's the system used most widely in HTML-based presentation infrastructure like Reveal.js. Co-authored-by: josh11b <josh11b@users.noreply.github.com>
945 B
945 B
Highlighting utilities
This directory collects syntax highlighting utilities for use with Carbon code.
highlight.js
This JavaScript syntax highlighting system is used on webpages or in presentation software like reveal.js.
The code is in [highlightjs_carbon_lang.js], and you can use it by registering it after you load highlight.js:
<script type="module">
import Carbon from './highlightjs_carbon_lang.js';
hljs.registerLanguage('Carbon', Carbon);
hljs.highlightAll();
</script>
See [highlightjs_example.html] for a more complete example.
It includes many Carbon-specific markup indicators that may be useful to customize display or highlighting of Carbon code.