Skip to content

Commit 2bc18a1

Browse files
intro: lexers for markdown code block syntax highlights in writing tips
1 parent cc9e042 commit 2bc18a1

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
- mkdocs: round corners style for buttons etc
1414
- intro: add code of respect
1515
- dev: stale issue & pr scheduled check (monthly)
16+
- intro: lexers for markdown code block syntax highlights in writing tips
1617

1718
## Changed
1819
- mkdocs: correct github url for repo and edit link

docs/writing-tips.md

+17
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,23 @@ Code blocks include a copy icon automatically
149149

150150
Syntax highlighting in code blocks
151151

152+
[Available Lexers for syntax highlights](https://pygments.org/docs/lexers/#pygments.lexers.configs.UnixConfigLexer){target=_blank .md-button}
153+
154+
155+
??? INFO "Lexers used by Practicalli"
156+
- `clojure` Clojure and ClojureScript code
157+
- `json` api data, etc.
158+
- `markdown` markdown text
159+
- `make` Makefile task definitions
160+
- `unixconfig` general configuration files
161+
- `yaml` .yaml / .yml configuration files, e.g. GitHub Workflow
162+
- `shell` scripts (alternatives `bash`, `zsh`)
163+
- `shell-session` prompt, command and output for one or more commands
164+
- `docker` and compose configs
165+
- `html`
166+
- `mermaid` ([Diagrams - Material for MkDocs](https://squidfunk.github.io/mkdocs-material/reference/diagrams/))
167+
168+
152169
```clojure
153170
(defn my-function ; Write a simple function
154171
"With a lovely doc-string"

0 commit comments

Comments
 (0)