aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorThomas Voss <mail@thomasvoss.com> 2024-09-23 10:56:56 +0200
committerThomas Voss <mail@thomasvoss.com> 2024-09-23 10:56:56 +0200
commit5417993a152fc436b167978594f52ebf22068c7e (patch)
tree28e55fd0cefce664e28916db4f834a7fb8fa4929 /README.org
Genesis commit
Diffstat (limited to 'README.org')
-rw-r--r--README.org13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..6fae4d8
--- /dev/null
+++ b/README.org
@@ -0,0 +1,13 @@
+* GSP Major Mode
+
+This package provides a Tree-Sitter powered major-mode for editing GSP
+files. GSP is a preprocessor for HTML to make web-development less
+painful. You can learn more about it [[https://git.thomasvoss.com/gsp][here]].
+
+At the moment this package provides support for indentation and syntax
+highlighting. The level of syntax highlighting can be configured by
+setting ~treesit-font-lock-level~, and the specific elements to highlight
+can be configured by customizing ~treesit-font-lock-feature-list~.
+
+Other user-customizable variables of note are ~gsp-ts-indent-offset~,
+~gsp-ts-font-lock-rules~, and ~gsp-ts-ident-rules~.