Skip to content

Commit

Permalink
update Documentation.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lukepistrol committed Nov 13, 2022
1 parent f73d534 commit be8cbb0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion Sources/CodeEditTextView/Documentation.docc/Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,18 @@ A code editor with syntax highlighting powered by tree-sitter.

![logo](codeedittextview-logo)

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.

This package includes both `AppKit` and `SwiftUI` components. It also relies on the `CodeEditLanguages` and `Theme` module.

![banner](preview)

## Syntax Highlighting

``CodeEditTextView`` uses `tree-sitter` for syntax highlighting. A list of already supported languages can be found [here](https://github.com/CodeEditApp/CodeEditTextView/issues/15).

New languages need to be added to the [CodeEditLanguages](https://github.com/CodeEditApp/CodeEditLanguages) repo.

## Dependencies

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

- ``EditorTheme``

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit be8cbb0

Please sign in to comment.