Skip to content

Commit be8cbb0

Browse files
committed
update Documentation.md
1 parent f73d534 commit be8cbb0

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

Sources/CodeEditTextView/Documentation.docc/Documentation.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,18 @@ A code editor with syntax highlighting powered by tree-sitter.
66

77
![logo](codeedittextview-logo)
88

9+
An Xcode-inspired code editor view written in Swift powered by tree-sitter for [CodeEdit](https://github.com/CodeEditApp/CodeEdit). Features include syntax highlighting (based on the provided theme), code completion, find and replace, text diff, validation, current line highlighting, minimap, inline messages (warnings and errors), bracket matching, and more.
10+
911
This package includes both `AppKit` and `SwiftUI` components. It also relies on the `CodeEditLanguages` and `Theme` module.
1012

13+
![banner](preview)
14+
15+
## Syntax Highlighting
16+
17+
``CodeEditTextView`` uses `tree-sitter` for syntax highlighting. A list of already supported languages can be found [here](https://github.com/CodeEditApp/CodeEditTextView/issues/15).
18+
19+
New languages need to be added to the [CodeEditLanguages](https://github.com/CodeEditApp/CodeEditLanguages) repo.
20+
1121
## Dependencies
1222

1323
Special thanks to both [Marcin Krzyzanowski](https://twitter.com/krzyzanowskim) & [Matt Massicotte](https://twitter.com/mattie) for the great work they've done!
@@ -27,4 +37,3 @@ Special thanks to both [Marcin Krzyzanowski](https://twitter.com/krzyzanowskim)
2737
### Theme
2838

2939
- ``EditorTheme``
30-
445 KB
Loading

0 commit comments

Comments
 (0)