Lib.rs

This is a fork of Syntect.

This fork is very similar to the original version 4.6 of Syntect, the last non yanked version of Syntect at time of writing, but modified to return errors instead of panicking in some cases of failing syntaxic colorings.

Please try to use the original Syntect instead of this temporary fork. There's no project to maintain it for a long time nor for adding features: as soon as Syntect 5 is released without cases of panics and the applications using this fork are ported, it will be terminated.

If you really feel like you need to use this, contact @dystroy on the Miaou chat.

lib.rs:

Welcome to the syntect docs.

Much more info about syntect is available on the Github Page.

May I suggest that you start by reading the Readme.md file in the main repo. Once you're done with that you can look at the docs for parsing::SyntaxSet and for the easy module.

Almost everything in syntect is divided up into either the parsing module for turning text into text annotated with scopes, and the highlighting module for turning annotated text into styled/colored text.

Some docs have example code but a good place to look is the syncat example as well as the source code for the easy module in easy.rs as that shows how to plug the various parts together for common use cases.