Add information about highlighting to the docs

rzk-lang · May 21, 2023 · 142ec00 · 142ec00
1 parent 5c7425f
commit 142ec00
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/docs/docs/tools/highlight.md b/docs/docs/tools/highlight.md
@@ -0,0 +1,8 @@
+# Syntax Highlighting
+
+Currently basic syntax highlighting is supported for several environments:
+
+1. <a href="https://marketplace.visualstudio.com/items?itemName=NikolaiKudasovfizruk.rzk-1-experimental-highlighting" target="_blank">`vscode-rzk` VS Code extension</a> provides syntax highlighting for both `*.rzk` files and `rzk` code blocks in Markdown files.
+2. HighlightJS syntax highlighting (used by MkDocs) is available at <a href="https://github.com/fizruk/rzk/blob/develop/docs/custom_theme/js/rzk.js" target="_blank">https://github.com/fizruk/rzk/blob/develop/docs/custom_theme/js/rzk.js</a>
+3. Pygments syntax highlighting is available a Python package at <a href="https://github.com/fizruk/rzk/tree/develop/rzk/RzkLexer#readme" target="_blank">https://github.com/fizruk/rzk/tree/develop/rzk/RzkLexer</a>. This syntax highlighter is suitable for using with LaTeX (e.g. with `minted` package).
+4. There is also an obsolete <a href="https://github.com/fizruk/rzk/blob/develop/try-rzk/playground.html#L219-L269" target="_blank">syntax highlighting mode for CodeMirror 5</a>.
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -8,6 +8,7 @@ nav:
     - Rendering Diagrams: rzk-1/render.md
     - Weak tope disjunction elimination: rzk-1/recId.md
   - Tools:
+    - Syntax Highlighting: tools/highlight.md
     - IDE support: tools/ide.md
     - Continuous Verification: tools/continuous.md
   - Related Projects: