diff options
| author | sharkdp <davidpeter@web.de> | 2020-10-14 08:24:20 +0200 |
|---|---|---|
| committer | sharkdp <davidpeter@web.de> | 2020-10-14 08:24:20 +0200 |
| commit | bf78b74db4274361d2d6eb4746e1c77667b99255 (patch) | |
| tree | 59f8efdf64586345a147ca11153ef703b27d24d7 /doc | |
| parent | f80fba4d24fddbac4f481c6639f7b334dec149a1 (diff) | |
Minor README improvements
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/assets.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/assets.md b/doc/assets.md index 20da7f55..b70603de 100644 --- a/doc/assets.md +++ b/doc/assets.md @@ -1,7 +1,7 @@ -## Add New Syntax Highlighting into the bat binary +## Adding new builtin languages for syntax highlighting + +Should you find that a particular syntax is not available within `bat` and think it should be included in `bat` by default, you can follow the instructions outlined below. -Should you find a particular syntax is not available within `bat` and think it should be included in `bat` by default, you can follow the instructions and policies outlined below. - `bat` uses the excellent [syntect](https://github.com/trishume/syntect) library to highlight source code. As a basis, syntect uses [Sublime Text](https://www.sublimetext.com/) syntax definitions in the `.sublime-syntax` format. @@ -31,6 +31,10 @@ in the `.sublime-syntax` format. Make sure that the local cache does not interfere with the internally stored syntaxes and themes (`bat cache --clear`). +## Criteria for inclusion of new syntaxes + +* More than 10,000 downloads on packagecontrol.io/ + ### Manual modifications The following files have been manually modified after converting from a `.tmLanguage` file: @@ -54,7 +58,3 @@ The following files have been manually modified after converting from a `.tmLang https://github.com/seanjames777/SML-Language-Definition/blob/master/sml.tmLanguage * `Cabal.sublime_syntax` has been added manually from https://github.com/SublimeHaskell/SublimeHaskell/ - we don't want to include the whole submodule because it includes other syntaxes ("Haskell improved") as well. - -## Criteria for inclusion of new syntaxes - -* More than 10,000 downloads on packagecontrol.io/
\ No newline at end of file |