Skip to content

Commit 3fccfa3

Browse files
author
Documenter.jl
committed
build based on 5a05d49
1 parent 636517c commit 3fccfa3

16 files changed

Lines changed: 29 additions & 29 deletions

File tree

dev/.documenter-siteinfo.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"documenter_version":"1.17.0","generation_timestamp":"2026-05-20T21:56:56","julia_version":"1.12.6"}}
1+
{"documenter":{"documenter_version":"1.17.0","generation_timestamp":"2026-05-22T08:08:13","julia_version":"1.12.6"}}

dev/api/index.html

Lines changed: 12 additions & 12 deletions
Large diffs are not rendered by default.

dev/blue_style/index.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

dev/cli/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,4 +188,4 @@
188188
echo 'f(x,y)=x+y' | jlfmt --config-dir=./src
189189

190190
# Useful in editor integrations to respect project config
191-
cat file.jl | jlfmt --config-dir=$(dirname file.jl)</code></pre><p>The formatter will search for <code>.JuliaFormatter.toml</code> in the specified directory and its parent directories, just like it does for regular file inputs.</p><h2 id="Conventions"><a class="docs-heading-anchor" href="#Conventions">Conventions</a><a id="Conventions-1"></a><a class="docs-heading-anchor-permalink" href="#Conventions" title="Permalink"></a></h2><p><code>jlfmt</code> follows standard CLI conventions:</p><ul><li>Exit code 0 on success</li><li>Exit code 1 on formatting errors or when <code>--check</code> detects unformatted files</li><li>Formatted output to stdout (default) or in-place with <code>--inplace</code></li><li>Error messages to stderr</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../config/">« Configuration File</a><a class="docs-footer-nextpage" href="../api/">API Reference »</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.17.0 on <span class="colophon-date" title="Wednesday 20 May 2026 21:56">Wednesday 20 May 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
191+
cat file.jl | jlfmt --config-dir=$(dirname file.jl)</code></pre><p>The formatter will search for <code>.JuliaFormatter.toml</code> in the specified directory and its parent directories, just like it does for regular file inputs.</p><h2 id="Conventions"><a class="docs-heading-anchor" href="#Conventions">Conventions</a><a id="Conventions-1"></a><a class="docs-heading-anchor-permalink" href="#Conventions" title="Permalink"></a></h2><p><code>jlfmt</code> follows standard CLI conventions:</p><ul><li>Exit code 0 on success</li><li>Exit code 1 on formatting errors or when <code>--check</code> detects unformatted files</li><li>Formatted output to stdout (default) or in-place with <code>--inplace</code></li><li>Error messages to stderr</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../config/">« Configuration File</a><a class="docs-footer-nextpage" href="../api/">API Reference »</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.17.0 on <span class="colophon-date" title="Friday 22 May 2026 08:08">Friday 22 May 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/config/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@
1111
│ ├─ .JuliaFormatter.toml
1212
│ └─ sub_code1.jl
1313
└─ subdir2
14-
└─ sub_code2.jl</code></pre><p>and call <code>format(&quot;dir&quot;)</code>, <code>code.jl</code> and <code>sub_code2.jl</code> will be formatted according to the rules defined in <code>dir/.JuliaFormatter.toml</code>, while formatting <code>sub_code1.jl</code> will be configured by <code>dir/subdir1/.JuliaFormatter.toml</code>.</p><h2 id="ignore"><a class="docs-heading-anchor" href="#ignore">Ignoring specific files and directories</a><a id="ignore-1"></a><a class="docs-heading-anchor-permalink" href="#ignore" title="Permalink"></a></h2><p>If there is an entry in <code>.JuliaFormatter.toml</code> with</p><pre><code class="language-toml hljs">ignore = [&quot;file.jl&quot;, &quot;directory&quot;, &quot;file_*.jl&quot;]</code></pre><p>then all of these files will be reported as already formatted: <code>./file.jl</code>, <code>./directory/something.jl</code> <code>./other_directory/file.jl</code>, <code>file_1.jl</code>, <code>.other_directory/file_name.jl</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../sciml_style/">« SciML Style</a><a class="docs-footer-nextpage" href="../cli/">Command Line Interface »</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.17.0 on <span class="colophon-date" title="Wednesday 20 May 2026 21:56">Wednesday 20 May 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
14+
└─ sub_code2.jl</code></pre><p>and call <code>format(&quot;dir&quot;)</code>, <code>code.jl</code> and <code>sub_code2.jl</code> will be formatted according to the rules defined in <code>dir/.JuliaFormatter.toml</code>, while formatting <code>sub_code1.jl</code> will be configured by <code>dir/subdir1/.JuliaFormatter.toml</code>.</p><h2 id="ignore"><a class="docs-heading-anchor" href="#ignore">Ignoring specific files and directories</a><a id="ignore-1"></a><a class="docs-heading-anchor-permalink" href="#ignore" title="Permalink"></a></h2><p>If there is an entry in <code>.JuliaFormatter.toml</code> with</p><pre><code class="language-toml hljs">ignore = [&quot;file.jl&quot;, &quot;directory&quot;, &quot;file_*.jl&quot;]</code></pre><p>then all of these files will be reported as already formatted: <code>./file.jl</code>, <code>./directory/something.jl</code> <code>./other_directory/file.jl</code>, <code>file_1.jl</code>, <code>.other_directory/file_name.jl</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../sciml_style/">« SciML Style</a><a class="docs-footer-nextpage" href="../cli/">Command Line Interface »</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.17.0 on <span class="colophon-date" title="Friday 22 May 2026 08:08">Friday 22 May 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/custom_alignment/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,4 +133,4 @@
133133
100 300 400
134134
1 ee 40000
135135
2 a b
136-
]</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../transforms/">« Syntax Transforms</a><a class="docs-footer-nextpage" href="../yas_style/">YAS Style »</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.17.0 on <span class="colophon-date" title="Wednesday 20 May 2026 21:56">Wednesday 20 May 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
136+
]</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../transforms/">« Syntax Transforms</a><a class="docs-footer-nextpage" href="../yas_style/">YAS Style »</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.17.0 on <span class="colophon-date" title="Friday 22 May 2026 08:08">Friday 22 May 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/how_it_works/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@
3131
...,
3232
argument120
3333
) # way over margin limit !!!
34-
end</code></pre><blockquote><p>You can read how code is nested in the style section.</p></blockquote><p>Once the <code>FST</code> has been nested it&#39;s then printed out to a file and voila! You have a formatted version of your code!</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Introduction</a><a class="docs-footer-nextpage" href="../style/">Code Style »</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.17.0 on <span class="colophon-date" title="Wednesday 20 May 2026 21:56">Wednesday 20 May 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
34+
end</code></pre><blockquote><p>You can read how code is nested in the style section.</p></blockquote><p>Once the <code>FST</code> has been nested it&#39;s then printed out to a file and voila! You have a formatted version of your code!</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Introduction</a><a class="docs-footer-nextpage" href="../style/">Code Style »</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.17.0 on <span class="colophon-date" title="Friday 22 May 2026 08:08">Friday 22 May 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)