How would one add a code highlighting keyword?

r00ster91 · March 16, 2021, 9:44am

If I for example want to highlight Rust code for a code block then I type 3 grave accents and then rust to tell the markdown parser that this is Rust code. Then I write my code and terminate the code block with another 3 grave accents, so that I end up with:

fn main() {
    println!("Ferris here!");
}

But where exactly is this keyword rust defined? I looked at https://github.com/github/linguist but that does not seem to be the right repository. Is there an open source repository where people can contribute new highlighting or keyword aliases and so on? Maybe outside the GitHub organization even?

canuckjacq · April 6, 2021, 3:01pm

Hi and welcome - that is the correct repository for the language detection library we use.

The file here:

github.com

github/linguist/blob/79b3da822eac18d334e012e97442a654955a08a3/lib/linguist/languages.yml

# Defines all Languages known to GitHub.
#
# fs_name               - Optional field. Only necessary as a replacement for the sample directory name if the
#                         language name is not a valid filename under the Windows filesystem (e.g., if it
#                         contains an asterisk).
# type                  - Either data, programming, markup, prose, or nil
# aliases               - An Array of additional aliases (implicitly
#                         includes name.downcase)
# ace_mode              - A String name of the Ace Mode used for highlighting whenever
#                         a file is edited. This must match one of the filenames in http://git.io/3XO_Cg.
#                         Use "text" if a mode does not exist.
# codemirror_mode       - A String name of the CodeMirror Mode used for highlighting whenever a file is edited.
#                         This must match a mode from https://git.io/vi9Fx
# codemirror_mime_type  - A String name of the file mime type used for highlighting whenever a file is edited.
#                         This should match the `mime` associated with the mode from https://git.io/f4SoQ
# wrap                  - Boolean wrap to enable line wrapping (default: false)
# extensions            - An Array of associated extensions (the first one is
#                         considered the primary extension, the others should be
#                         listed alphabetically)
# filenames             - An Array of filenames commonly associated with the language

This file has been truncated. show original

Includes the up to date list of languages, including any aliases.

This PR is probably a good example of how to propose any changes of your own.