Skip to content

Commit 8269331

Browse files
committed
readme: document custom yag codeblock lang
1 parent 7e55a60 commit 8269331

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,18 @@ _\*The `--` serves to pass `baseURL` to Hugo as opposed to the `npm run` command
2222
As this project uses the [EditorConfig](https://editorconfig.org/) standard, you will have to make sure that your
2323
editor supports it. Most modern editors do, but if you are unsure, check the EditorConfig page.
2424

25-
### Adding a new page
25+
### Authoring content
2626

27-
Pages are written in Markdown, with additional shortcodes provided by the Doks theme; refer to [its
27+
Pages are written in Markdown with additional shortcodes provided by the Doks theme; refer to [its
2828
documentation](<(https://getdoks.org/docs/start-here/getting-started/)>) for a complete list of features.
2929

30-
Note that if you use VSCode, this project provides custom workspace snippets to insert callouts, which you can activate
31-
in Markdown files by typing <kbd>Ctrl</kbd> + <kbd>Space</kbd> followed by `note`, `tip`, `warning`, or `danger`.
30+
If you are editing pages related to custom commands, note that codeblocks support a custom `yag` language for accurate
31+
syntax highlighting—do not use `go`. However, this feature is only enabled in production builds for performance, so `npm run dev` will _not_ highlight `yag` codeblocks. Use `npm run build` followed by `npm run preview` instead if you need to verify
32+
that code is highlighted correctly.
33+
34+
> [!TIP]
35+
> If you use VSCode, this project provides custom workspace snippets to insert callouts, which you can activate in
36+
> Markdown files by typing <kbd>Ctrl</kbd> + <kbd>Space</kbd> followed by `note`, `tip`, `warning`, or `danger`.
3237
3338
## License
3439

0 commit comments

Comments
 (0)