branch: elpa/typst-ts-mode commit 74eeca77b4aa6728a6af4293ced9f756a83a0bd3 Author: Meow King <mr.meowk...@anche.no> Commit: Meow King <mr.meowk...@anche.no>
doc: update README --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 819815990c..a9436b83a7 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ Tree Sitter support for Typst. Minimum Emacs version requirement: 29.  [Discussion on Zulip](https://meow-place.zulipchat.com/) -[Tickets](https://todo.sr.ht/~meow_king/typst-ts-mode): issues, feature requests, etc. +[Tickets](https://todo.sr.ht/~meow_king/typst-ts-mode): Issues, feature requests, etc. +[Announce](https://lists.sr.ht/~meow_king/typst-ts-mode-announce) Announcements. Subscribe to it to receive the latest news for `typst-ts-mode`. [Send a Patch](https://lists.sr.ht/~meow_king/typst-ts-mode-dev) ## Requirement @@ -67,7 +68,10 @@ For reference, this is my configuration. (use-package typst-ts-mode :elpaca (:type git :host sourcehut :repo "meow_king/typst-ts-mode") :custom + ;; don't add "--open" if you'd like `watch` to be an error detector (typst-ts-mode-watch-options "--open") + + ;; experimental settings (I'm the main dev, so I enable these) (typst-ts-mode-enable-raw-blocks-highlight t) (typst-ts-mode-highlight-raw-blocks-at-startup t)) ``` @@ -93,6 +97,7 @@ For customizable options: `customize` -> `typst-ts`. Here are some options you may find useful: 1. `typst-ts-mode-indent-offset` (default 4) and `typst-ts-mode-indent-offset-section` (default 2) + Set `typst-ts-mode-indent-offset-section` to 0 to make the structure flat. 2. `typst-ts-mode-executable-location` 3. `typst-ts-mode-watch-options`. Set this to `--open` so typst will open the compiled file for you. @@ -124,6 +129,7 @@ Here are some options you may find useful: rules. ### Raw block highlighting +_This is an experimental feature_ Only support tree-sitter languages. For more detailed documentation about raw block highlighting see [this documentation](./doc/raw-block-highlighing.md)