Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/serverpod/syntax_highlight
A better syntax highlighter for Flutter.
https://github.com/serverpod/syntax_highlight
Last synced: 3 months ago
JSON representation
A better syntax highlighter for Flutter.
- Host: GitHub
- URL: https://github.com/serverpod/syntax_highlight
- Owner: serverpod
- License: bsd-3-clause
- Created: 2023-07-14T15:40:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-15T12:03:32.000Z (11 months ago)
- Last Synced: 2024-03-16T09:31:29.116Z (11 months ago)
- Language: Dart
- Homepage:
- Size: 394 KB
- Stars: 18
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Syntax Highlight
The Syntax Highlight package uses the TextMate rules for highlighting code, which is used by many popular applications such as VSCode. Currently supported languages are Dart, SQL (Postgres), and YAML, but it is easy to extend the language support by dropping in new grammar files in the `grammar` directory.
## Usage
Before you can use the `Highlighter` class it needs to be initialized. The initialization will load the requested grammar files and parse them.
```dart
// Initialize the highlighter.
await Highlighter.initialize(['dart', 'yaml', 'sql']);
```
Next load a theme and create a highlighter.
```dart
// Load the default light theme and create a highlighter.
var theme = await HighlighterTheme.loadLightTheme();
var highlighter = Highlighter(
language: 'dart',
theme: theme,
);
```
Now, you can highlight your code by calling the `highlight` method. The `highlight` method will return a `TextSpan`, which you can use in a `Text` widget.
```dart
Widget build(BuildContext context) {
var highlightedCode = highlighter.highlight(myCodeString);
return Text.rich(highlightedCode);
}
```
An example of highlighted code:
