bat/assets at b68c038db8078b3afc4086e72efb830b430fbc26 - Mirrors/bat

mirror of https://github.com/sharkdp/bat synced 2024-11-15 08:37:12 +00:00

History

sharkdp b68c038db8 Update link to new issue		2018-11-11 11:08:08 +01:00
..
syntaxes	Update SHA1 in TOML submodule	2018-11-05 19:37:23 +01:00
themes	Add sublime-snazzy theme	2018-10-20 11:32:25 +02:00
.ignore	Add .ignore files to avoid searching asset folders	2018-05-25 17:44:50 +02:00
create.sh	Update link to new issue	2018-11-11 11:08:08 +01:00
JavaDoc.sublime-syntax.patch	Workaround for #81	2018-10-04 11:09:41 +02:00
README.md	Update VimL syntax	2018-10-05 18:44:51 +02:00
syntaxes.bin	Update assets	2018-10-17 23:14:07 +02:00
theme_preview.rs	Small style changes to --list-themes	2018-08-28 20:24:13 +02:00
themes.bin	Bump version, update assets	2018-09-12 22:01:01 +02:00

Syntax Highlighting in bat

bat uses the syntect library to highlight source code. As a basis, syntect uses Sublime Text syntax definitions in the .sublime-syntax format.

In order to add new syntaxes to bat, follow these steps:

Find a Sublime Text syntax for the given language, preferably in a separate Git repository which can be included as a submodule (under assets/syntaxes).
If the Sublime Text syntax is only available as a .tmLanguage file, open the file in Sublime Text and convert it to a .sublime-syntax file via Tools -> Developer -> New Syntax from XXX.tmLanguage.... Save the new file in the assets/syntaxes folder.
Run the create.sh script. It calls bat cache --init to parse all available .sublime-syntax files and serialize them to a syntaxes.bin file (in this folder).
Re-compile bat. At compilation time, the syntaxes.bin file will be stored inside the bat binary.

Make sure that the local cache does not interfere with the internally stored syntaxes and themes (bat cache --clear).

The following files have been manually modified after converting from a .tmLanguage file: