build based on 769b53d

Author: Documenter.jl

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"documenter_version":"1.14.1","generation_timestamp":"2025-10-14T09:13:51","julia_version":"1.13.0-DEV.1302"}}
+{"documenter":{"documenter_version":"1.14.1","generation_timestamp":"2025-10-15T12:44:36","julia_version":"1.13.0-DEV.1315"}}

dev/index.html

@@ -11,7 +11,7 @@
  @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((5:5, :face, :julia_number))
  @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((6:6, :face, :julia_operator))
  @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((7:7, :face, :julia_number))
- @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((8:8, :face, :julia_rainbow_paren_1))</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/JuliaSyntaxHighlighting.jl/blob/82830a4d49af12e4f8e6a3d46a957330f6a85ba5/src/JuliaSyntaxHighlighting.jl#L372-L404">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="JuliaSyntaxHighlighting.highlight!" href="#JuliaSyntaxHighlighting.highlight!"><code>JuliaSyntaxHighlighting.highlight!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">highlight!(content::Union{AnnotatedString, SubString{AnnotatedString}},
+ @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((8:8, :face, :julia_rainbow_paren_1))</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/JuliaSyntaxHighlighting.jl/blob/769b53d015d0d2322dc0e04f42d5e5ef0152b1b0/src/JuliaSyntaxHighlighting.jl#L387-L419">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="JuliaSyntaxHighlighting.highlight!" href="#JuliaSyntaxHighlighting.highlight!"><code>JuliaSyntaxHighlighting.highlight!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">highlight!(content::Union{AnnotatedString, SubString{AnnotatedString}},
            ast::JuliaSyntax.GreenNode = &lt;parsed content&gt;;
            syntax_errors::Bool = false) -&gt; content</code></pre><p>Modify <code>content</code> by applying syntax highlighting using <code>JuliaSyntax</code>.</p><p>By default, <code>JuliaSyntax.parseall</code> is used to generate to <code>ast</code> with the <code>ignore_errors</code> keyword argument set to <code>true</code>. Alternatively, one may provide a pre-generated <code>ast</code>.</p><p>When <code>syntax_errors</code> is set, the <code>julia_error</code> face is applied to detected syntax errors.</p><div class="admonition is-warning" id="Warning-954dbede668edadf"><header class="admonition-header">Warning<a class="admonition-anchor" href="#Warning-954dbede668edadf" title="Permalink"></a></header><div class="admonition-body"><p>Note that the particular faces used by <code>JuliaSyntax</code>, and the way they are applied, is subject to change.</p></div></div><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; str = Base.AnnotatedString(&quot;sum(1:8)&quot;)
 &quot;sum(1:8)&quot;
@@ -26,4 +26,4 @@
  @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((5:5, :face, :julia_number))
  @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((6:6, :face, :julia_operator))
  @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((7:7, :face, :julia_number))
- @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((8:8, :face, :julia_rainbow_paren_1))</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/JuliaSyntaxHighlighting.jl/blob/82830a4d49af12e4f8e6a3d46a957330f6a85ba5/src/JuliaSyntaxHighlighting.jl#L419-L454">source</a></section></article><h2 id="stdlib-jsh-faces"><a class="docs-heading-anchor" href="#stdlib-jsh-faces">Faces</a><a id="stdlib-jsh-faces-1"></a><a class="docs-heading-anchor-permalink" href="#stdlib-jsh-faces" title="Permalink"></a></h2><p>The <code>highlight</code>/<code>highlight!</code> methods work by applying custom faces to Julia code. As part of the standard library, these faces use privileged face names, of the form <code>julia_*</code>. These can be re-used in other packages, and customised with <code>faces.toml</code> configuration.</p><div class="admonition is-warning" id="Unstable-faces-7bbd7bc33d153615"><header class="admonition-header">Unstable faces<a class="admonition-anchor" href="#Unstable-faces-7bbd7bc33d153615" title="Permalink"></a></header><div class="admonition-body"><p>The particular faces used by <code>JuliaSyntaxHighlighting</code> are liable to change without warning in point releases. As the syntax highlighting rules are refined over time, changes should become less and less frequent though.</p></div></div><p>The current set of faces, and their default values are as follows:</p><ul><li><code>julia_macro</code>: magenta</li><li><code>julia_symbol</code>: magenta</li><li><code>julia_singleton_identifier</code>: inherits from <code>julia_symbol</code></li><li><code>julia_type</code>: yellow</li><li><code>julia_typedec</code>: bright blue</li><li><code>julia_comment</code>: grey</li><li><code>julia_string</code>: green</li><li><code>julia_regex</code>: inherits from <code>julia_string</code></li><li><code>julia_backslash_literal</code>: magenta, inherits from <code>julia_string</code></li><li><code>julia_string_delim</code>: bright green</li><li><code>julia_cmdstring</code>: inherits from <code>julia_string</code></li><li><code>julia_char</code>: inherits from <code>julia_string</code></li><li><code>julia_char_delim</code>: inherits from <code>julia_string_delim</code></li><li><code>julia_number</code>: bright magenta</li><li><code>julia_bool</code>: inherits from <code>julia_number</code></li><li><code>julia_funcall</code>: cyan</li><li><code>julia_broadcast</code>: bright blue, bold</li><li><code>julia_builtin</code>: bright blue</li><li><code>julia_operator</code>: blue</li><li><code>julia_comparator</code>: inherits from <code>julia_operator</code></li><li><code>julia_assignment</code>: bright red</li><li><code>julia_keyword</code>: red</li><li><code>julia_parentheses</code>: unstyled</li><li><code>julia_unpaired_parentheses</code>: inherit from <code>julia_error</code> and <code>julia_parentheses</code></li><li><code>julia_error</code>: red background</li><li><code>julia_rainbow_paren_1</code>: bright green, inherits from <code>julia_parentheses</code></li><li><code>julia_rainbow_paren_2</code>: bright blue, inherits from <code>julia_parentheses</code></li><li><code>julia_rainbow_paren_3</code>: bright red, inherits from <code>julia_parentheses</code></li><li><code>julia_rainbow_paren_4</code>: inherits from <code>julia_rainbow_paren_1</code></li><li><code>julia_rainbow_paren_5</code>: inherits from <code>julia_rainbow_paren_2</code></li><li><code>julia_rainbow_paren_6</code>: inherits from <code>julia_rainbow_paren_3</code></li><li><code>julia_rainbow_bracket_1</code>: blue, inherits from <code>julia_parentheses</code></li><li><code>julia_rainbow_bracket_2</code>: bright<em>magenta, inherits from `julia</em>parentheses`</li><li><code>julia_rainbow_bracket_3</code>: inherits from <code>julia_rainbow_bracket_1</code></li><li><code>julia_rainbow_bracket_4</code>: inherits from <code>julia_rainbow_bracket_2</code></li><li><code>julia_rainbow_bracket_5</code>: inherits from <code>julia_rainbow_bracket_1</code></li><li><code>julia_rainbow_bracket_6</code>: inherits from <code>julia_rainbow_bracket_2</code></li><li><code>julia_rainbow_curly_1</code>: bright yellow, inherits from <code>julia_parentheses</code></li><li><code>julia_rainbow_curly_2</code>: yellow, inherits from <code>julia_parentheses</code></li><li><code>julia_rainbow_curly_3</code>: inherits from <code>julia_rainbow_curly_1</code></li><li><code>julia_rainbow_curly_4</code>: inherits from <code>julia_rainbow_curly_2</code></li><li><code>julia_rainbow_curly_5</code>: inherits from <code>julia_rainbow_curly_1</code></li><li><code>julia_rainbow_curly_6</code>: inherits from <code>julia_rainbow_curly_2</code></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="internals/">Internals »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.14.1 on <span class="colophon-date" title="Tuesday 14 October 2025 09:13">Tuesday 14 October 2025</span>. Using Julia version 1.13.0-DEV.1302.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+ @NamedTuple{region::UnitRange{Int64}, label::Symbol, value}((8:8, :face, :julia_rainbow_paren_1))</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/JuliaSyntaxHighlighting.jl/blob/769b53d015d0d2322dc0e04f42d5e5ef0152b1b0/src/JuliaSyntaxHighlighting.jl#L434-L469">source</a></section></article><h2 id="stdlib-jsh-faces"><a class="docs-heading-anchor" href="#stdlib-jsh-faces">Faces</a><a id="stdlib-jsh-faces-1"></a><a class="docs-heading-anchor-permalink" href="#stdlib-jsh-faces" title="Permalink"></a></h2><p>The <code>highlight</code>/<code>highlight!</code> methods work by applying custom faces to Julia code. As part of the standard library, these faces use privileged face names, of the form <code>julia_*</code>. These can be re-used in other packages, and customised with <code>faces.toml</code> configuration.</p><div class="admonition is-warning" id="Unstable-faces-7bbd7bc33d153615"><header class="admonition-header">Unstable faces<a class="admonition-anchor" href="#Unstable-faces-7bbd7bc33d153615" title="Permalink"></a></header><div class="admonition-body"><p>The particular faces used by <code>JuliaSyntaxHighlighting</code> are liable to change without warning in point releases. As the syntax highlighting rules are refined over time, changes should become less and less frequent though.</p></div></div><p>The current set of faces, and their default values are as follows:</p><ul><li><code>julia_macro</code>: magenta</li><li><code>julia_symbol</code>: magenta</li><li><code>julia_singleton_identifier</code>: inherits from <code>julia_symbol</code></li><li><code>julia_type</code>: yellow</li><li><code>julia_typedec</code>: bright blue</li><li><code>julia_comment</code>: grey</li><li><code>julia_string</code>: green</li><li><code>julia_regex</code>: inherits from <code>julia_string</code></li><li><code>julia_backslash_literal</code>: magenta, inherits from <code>julia_string</code></li><li><code>julia_string_delim</code>: bright green</li><li><code>julia_cmdstring</code>: inherits from <code>julia_string</code></li><li><code>julia_char</code>: inherits from <code>julia_string</code></li><li><code>julia_char_delim</code>: inherits from <code>julia_string_delim</code></li><li><code>julia_number</code>: bright magenta</li><li><code>julia_bool</code>: inherits from <code>julia_number</code></li><li><code>julia_funcall</code>: cyan</li><li><code>julia_broadcast</code>: bright blue, bold</li><li><code>julia_builtin</code>: bright blue</li><li><code>julia_operator</code>: blue</li><li><code>julia_comparator</code>: inherits from <code>julia_operator</code></li><li><code>julia_assignment</code>: bright red</li><li><code>julia_keyword</code>: red</li><li><code>julia_parentheses</code>: unstyled</li><li><code>julia_unpaired_parentheses</code>: inherit from <code>julia_error</code> and <code>julia_parentheses</code></li><li><code>julia_error</code>: red background</li><li><code>julia_rainbow_paren_1</code>: bright green, inherits from <code>julia_parentheses</code></li><li><code>julia_rainbow_paren_2</code>: bright blue, inherits from <code>julia_parentheses</code></li><li><code>julia_rainbow_paren_3</code>: bright red, inherits from <code>julia_parentheses</code></li><li><code>julia_rainbow_paren_4</code>: inherits from <code>julia_rainbow_paren_1</code></li><li><code>julia_rainbow_paren_5</code>: inherits from <code>julia_rainbow_paren_2</code></li><li><code>julia_rainbow_paren_6</code>: inherits from <code>julia_rainbow_paren_3</code></li><li><code>julia_rainbow_bracket_1</code>: blue, inherits from <code>julia_parentheses</code></li><li><code>julia_rainbow_bracket_2</code>: bright<em>magenta, inherits from `julia</em>parentheses`</li><li><code>julia_rainbow_bracket_3</code>: inherits from <code>julia_rainbow_bracket_1</code></li><li><code>julia_rainbow_bracket_4</code>: inherits from <code>julia_rainbow_bracket_2</code></li><li><code>julia_rainbow_bracket_5</code>: inherits from <code>julia_rainbow_bracket_1</code></li><li><code>julia_rainbow_bracket_6</code>: inherits from <code>julia_rainbow_bracket_2</code></li><li><code>julia_rainbow_curly_1</code>: bright yellow, inherits from <code>julia_parentheses</code></li><li><code>julia_rainbow_curly_2</code>: yellow, inherits from <code>julia_parentheses</code></li><li><code>julia_rainbow_curly_3</code>: inherits from <code>julia_rainbow_curly_1</code></li><li><code>julia_rainbow_curly_4</code>: inherits from <code>julia_rainbow_curly_2</code></li><li><code>julia_rainbow_curly_5</code>: inherits from <code>julia_rainbow_curly_1</code></li><li><code>julia_rainbow_curly_6</code>: inherits from <code>julia_rainbow_curly_2</code></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="internals/">Internals »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.14.1 on <span class="colophon-date" title="Wednesday 15 October 2025 12:44">Wednesday 15 October 2025</span>. Using Julia version 1.13.0-DEV.1315.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>