Skip to content
This repository has been archived by the owner on Jun 8, 2024. It is now read-only.

Commit

Permalink
Merge pull request #144 from pachi/patch-1
Browse files Browse the repository at this point in the history
Update README.md showing simple typstfmt.toml example
  • Loading branch information
astrale-sharp committed Jan 15, 2024
2 parents 28006c0 + ffc394c commit 83ff7d5
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,14 @@ Basic formatter for the Typst language with a future!
- Good defaults.
- Config file: run `typstfmt --make-default-config` to create a typstfmt.toml
file that you can customize!

The following lines show the contents of a simple `typstfmt.toml` file:
```toml
indent_space = 2
max_line_length = 80
experimental_args_breaking_consecutive = false
line_wrap = true
```
- Disable the formatting by surrounding code with `// typstfmt::off` and `//
typstfmt::on`. (Experimental and broken)

Expand Down Expand Up @@ -149,4 +157,4 @@ finding which range, when formatted, was not valid anymore (broke the semantic o
- @jeffa5 for contributing ideas on the initial design
- @Andrew15-5, for the many suggestions, issues and feedback.
- @aghriss for a bug fix
- @taooceros for the alignment of math block
- @taooceros for the alignment of math block

0 comments on commit 83ff7d5

Please sign in to comment.