branch: elpa/typst-ts-mode
commit f24e51271dbb350798852a6165f5b541cb3a75b6
Author: Meow King <mr.meowk...@anche.no>
Commit: Meow King <mr.meowk...@anche.no>
chore: doc
---
README.md | 51 ++++++++++++++++++++++++++-------------------------
1 file changed, 26 insertions(+), 25 deletions(-)
diff --git a/README.md b/README.md
index ae6ebdcf06..dc42c06188 100644
--- a/README.md
+++ b/README.md
@@ -45,17 +45,17 @@ Example configuration.
## Keys
-**`C-c C-c c`** : **`typst-ts-mode-compile-and-preview`**
-**`C-c C-c C`** : **`typst-ts-mode-compile`**
-**`C-c C-c w`** : **`typst-ts-mode-watch-toggle`**
-**`C-c C-c p`** : **`typst-ts-mode-preview`**
-**`M-<left>`** : **`typst-ts-mode-heading-decrease`**
-**`M-<right>`** : **`typst-ts-mode-heading-increase`**
-**`M-<up>`** : **`typst-ts-mode-heading-up`**
-**`M-<down>`** : **`typst-ts-mode-heading-down`**
-**`TAB`** : **`typst-ts-mode-cycle`**
-**`M-<return>`**: **`typst-ts-mode-meta-return`**
-**`<return>`** : **`typst-ts-mode-return`**
+**C-c C-c c** : **typst-ts-mode-compile-and-preview**
+**C-c C-c C** : **typst-ts-mode-compile**
+**C-c C-c w** : **typst-ts-mode-watch-toggle**
+**C-c C-c p** : **typst-ts-mode-preview**
+**M-<left>** : **typst-ts-mode-heading-decrease**
+**M-<right>** : **typst-ts-mode-heading-increase**
+**M-<up>** : **typst-ts-mode-heading-up**
+**M-<down>** : **typst-ts-mode-heading-down**
+**TAB** : **typst-ts-mode-cycle**
+**M-<return>**: **typst-ts-mode-meta-return**
+**<return>** : **typst-ts-mode-return**
*NOTE*: `outline-minor-mode` is enabled by `typst-ts-mode`, so you can use
command
defined by `outline-minor-mode` such as `outline-cycle`.
@@ -65,36 +65,37 @@ defined by `outline-minor-mode` such as `outline-cycle`.
For customizable options: `customize` -> `typst-ts`.
Here are some options you may find useful:
-1. **`typst-ts-mode-indent-offset`** (default 4)
+1. **typst-ts-mode-indent-offset** (default 4)
Use [outline-indent-mode](https://sr.ht/~meow_king/outline-indent-mode/) to
behave like `org-indent-mode`.
-2. **`typst-ts-mode-executable-location`**
-3. **`typst-ts-mode-watch-options`**.
+2. **typst-ts-mode-executable-location**
+3. **typst-ts-watch-options**.
Set this to `--open` so typst will open the compiled file for you.
-4. **`typst-ts-mode-compile-options`**.
+4. **typst-ts-mode-compile-options**.
Note that setting `--open` has no use for this customization variable.
You can execute the shell command `typst compile <file> --open && sleep 1`
to view what is happening.
-5. **`typst-ts-mode-display-watch-process-bufer-automatically`**. (default
`t`)
+5. **typst-ts-mode-display-watch-process-bufer-automatically**. (default `t`)
so the `typst watch` process buffer appear when an error occurs, and
disappear when there is no error. You may find sometimes there is only one
error at a time, and it is because Typst itself do this style.
You may find `auto-save-visited-mode`,
[auto-save](https://github.com/manateelazycat/auto-save) or
[super-save](https://github.com/bbatsov/super-save) useful (or annoying).
-6. **`typst-ts-mode-before-compile-hook`** and
**`typst-ts-mode-after-compile-hook`**
-7. **`typst-ts-mode-return-autoincrement`** autoincrement lists when pressing
RETURN (default `t`).
+6. **typst-ts-mode-before-compile-hook** and
**typst-ts-mode-after-compile-hook**
+7. **typst-ts-mode-return-autoincrement** autoincrement lists when pressing
RETURN (default `t`).
+8. **typst-ts-mode-grammar-location**: used for grammar version check (may not
be accurate every time)
### Fontification
-1. **`typst-ts-mode-fontification-precise-level`** (default `'middle`)
+1. **typst-ts-mode-fontification-precise-level** (default `'middle`)
Available values: `min`, `middle` and `max`. Different level affects the
precision
of the fontification. For example, `- item`, we may fontify the whole
expression
using one face, or two faces. Note it is related to the performance of
fontification
process, especially the first fontification process (when you open the
file).
-2. **`typst-ts-markup-header-same-height`** and
**`typst-ts-markup-header-scale`**
- Control header height. Note that it only works when
**`typst-ts-mode-fontification-precise-level`**
+2. **typst-ts-markup-header-same-height** and **typst-ts-markup-header-scale**
+ Control header height. Note that it only works when
**typst-ts-mode-fontification-precise-level**
is set to `max`.
3. Override default font lock rules
- Please see the documentation of **`typst-ts-mode-font-lock-rules`**, you
can find
+ Please see the documentation of **typst-ts-mode-font-lock-rules**, you can
find
how to override the whole font lock rules or only small part of the font
lock
rules.
@@ -104,9 +105,9 @@ _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)
-1. **`typst-ts-mode-enable-raw-blocks-highlight`** (default `nil`)
-2. **`typst-ts-mode-highlight-raw-blocks-at-startup`** (default `nil`)
-3. **`typst-ts-highlight-raw-block-langs-not-in-predefined-settings`**
(default `t`)
+1. **typst-ts-mode-enable-raw-blocks-highlight** (default `nil`)
+2. **typst-ts-mode-highlight-raw-blocks-at-startup** (default `nil`)
+3. **typst-ts-highlight-raw-block-langs-not-in-predefined-settings** (default
`t`)
### Consult Imenu Integration
If you use `consult-iemnu`
