Applied-Software/ghostty
5
0
Fork 0
mirror of https://github.com/ghostty-org/ghostty.git synced 2025-07-14 15:56:13 +03:00
Code Issues Packages Projects Releases Wiki Activity

add linting doc

Browse Source
This commit is contained in:
Patrick Fong
2023-09-28 11:14:31 -07:00
parent 09bafd753a
commit 3c44c08ffd
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -392,3 +392,13 @@ as `Console.app`. The easiest way I've found to view these is to just use the CL
$ sudo log stream --level debug --predicate 'subsystem=="com.mitchellh.ghostty"' $ sudo log stream --level debug --predicate 'subsystem=="com.mitchellh.ghostty"'
... ...
``` ```
### Linting
Ghostty's docs are linted using [Prettier](https://prettier.io). There is also a CI check that will fail if the formatting is off. Therefore, if you are modifying the docs, you may want to install it locally and run this from the repo root
```
prettier --write .
```
before you commit. Or simply install one of the many Prettier extensions out there for your editor of choice.