Skip to content

Commit 8e27464

Browse files
committed
docs: add schema information to README.md
1 parent 136b04a commit 8e27464

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,31 @@ Explore the demo to see how KoalaKeys works and to get ideas for creating custom
9595
9696
4. Open `index.html` to view the cheat sheet collection.
9797
98+
## Schema
99+
100+
Validate your YAML with the published JSON Schema:
101+
102+
- Public URL: https://rtuszik.github.io/KoalaKeys/schema/cheatsheet.schema.json
103+
- Per-file modeline (first line in each YAML):
104+
105+
```
106+
# yaml-language-server: $schema=https://rtuszik.github.io/KoalaKeys/schema/cheatsheet.schema.json
107+
```
108+
109+
- Neovim yamlls mapping (optional):
110+
111+
```lua
112+
require('lspconfig').yamlls.setup({
113+
settings = {
114+
yaml = {
115+
schemas = {
116+
["https://rtuszik.github.io/KoalaKeys/schema/cheatsheet.schema.json"] = "cheatsheets/*.yaml",
117+
},
118+
},
119+
},
120+
})
121+
```
122+
98123
## Contributing
99124
100125
Contributions are welcome! Feel free to submit issues, feature requests, or pull requests.

0 commit comments

Comments
 (0)