https://github.com/jlelong/vscode-latex-basics

LaTeX grammars for Visual Studio Code
https://github.com/jlelong/vscode-latex-basics

latex syntax-highlighting textmate-grammar visual-studio-code vscode vscode-language-support

Last synced: 2 months ago
JSON representation

LaTeX grammars for Visual Studio Code

• Host: GitHub
• URL: https://github.com/jlelong/vscode-latex-basics
• Owner: jlelong
• License: mit
• Created: 2021-11-26T19:31:28.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-20T08:54:43.000Z (4 months ago)
• Last Synced: 2024-10-12T21:44:47.203Z (3 months ago)
• Topics: latex, syntax-highlighting, textmate-grammar, visual-studio-code, vscode, vscode-language-support
• Language: TeX
• Homepage:
• Size: 728 KB
• Stars: 19
• Watchers: 1
• Forks: 10
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# VSCode LaTeX grammars

The files contained in this repository were originally part of https://github.com/James-Yu/LaTeX-Workshop. They have been extracted in the hope that they can be useful outside of the LaTeX-Workshop extension. In particular, these files are used by VS Code to provide built-in syntax highlighting for BibTeX, LaTeX and TeX (to appear in the January 2022 release).

This repository contains `tmLangugage` grammar files for LaTeX and BibTeX. These grammar files specifically target [Visual Studio Code](https://github.com/Microsoft/vscode) as they are accompanied by the corresponding language configuration files. However, the grammar files could in principle be consumed by any editor or extension using the TextMate language.

The grammar files support various embedded languages: `asymptote`, `c/c++`, `css`, `dot`, `gnuplot`, `html`, `java`, `javascript`, `julia`, `lua`, `python`, `ruby`, `scala`, `typescript`, `xml`, `yaml` and combined LaTeX and markdown to be used with the `markdown` package.

## License

If not otherwise specified (see below), files in this repository fall under the license stated in [LICENSE.txt](LICENSE.txt)

### LaTeX grammar

The LaTeX grammar [syntaxes/LaTeX.tmLanguage.json](syntaxes/LaTeX.tmLanguage.json) is based on https://github.com/textmate/latex.tmbundle/blob/master/Syntaxes/LaTeX.plist but has been largely modified. The original file falls under the following license

    Permission to copy, use, modify, sell and distribute this

    software is granted. This software is provided "as is" without

    express or implied warranty, and with no claim as to its

    suitability for any purpose.

### Combined LaTeX/Markdown grammar

The combined Markdown/LaTeX grammar [syntaxes/markdown-latex-combined.tmLanguage.json](syntaxes/markdown-latex-combined.tmLanguage.json) is generated from the Markdown grammar included in VSCode and falls under the license described in [markdown-latex-combined-license.txt](markdown-latex-combined-license.txt).

### C++ bailed out grammar

The file [syntaxes/cpp-grammar-bailout.tmLanguage.json](syntaxes/cpp-grammar-bailout.tmLanguage.json) is generated from https://github.com/jeff-hykin/better-cpp-syntax and falls under the license described in [cpp-bailout-license.txt](cpp-bailout-license.txt).

## Test

To run the grammar tests

    npm run test

The test cases are stored as `.tex` files under `test/colorize-fixtures`. Grammar test results are stored under `test/colorize-results`, which are automatically generated from the fixtures.