build based on 3fab35e

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.0-DEV.1168","generation_timestamp":"2023-12-30T02:44:21","documenter_version":"1.2.1"}}
+{"documenter":{"julia_version":"1.11.0-DEV.1248","generation_timestamp":"2024-01-12T04:22:16","documenter_version":"1.2.1"}}

dev/index.html

@@ -81,4 +81,4 @@
 julia> tryparse(SimpleColor, "#9558b2")
 SimpleColor(#9558b2)
 
-julia&gt; tryparse(SimpleColor, &quot;#nocolor&quot;)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/StyledStrings.jl/blob/3fab35e63140dccd4f8c28819d19049825d10e1b/src/faces.jl#L34-L55">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="Base.merge-Tuple{StyledStrings.Face, StyledStrings.Face}" href="#Base.merge-Tuple{StyledStrings.Face, StyledStrings.Face}"><code>Base.merge</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">merge(initial::Face, others::Face...)</code></pre><p>Merge the properties of the <code>initial</code> face and <code>others</code>, with later faces taking priority.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/StyledStrings.jl/blob/3fab35e63140dccd4f8c28819d19049825d10e1b/src/faces.jl#L450-L455">source</a></section></article></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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Saturday 30 December 2023 02:44">Saturday 30 December 2023</span>. Using Julia version 1.11.0-DEV.1168.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+julia&gt; tryparse(SimpleColor, &quot;#nocolor&quot;)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/StyledStrings.jl/blob/3fab35e63140dccd4f8c28819d19049825d10e1b/src/faces.jl#L34-L55">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="Base.merge-Tuple{StyledStrings.Face, StyledStrings.Face}" href="#Base.merge-Tuple{StyledStrings.Face, StyledStrings.Face}"><code>Base.merge</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">merge(initial::Face, others::Face...)</code></pre><p>Merge the properties of the <code>initial</code> face and <code>others</code>, with later faces taking priority.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/StyledStrings.jl/blob/3fab35e63140dccd4f8c28819d19049825d10e1b/src/faces.jl#L450-L455">source</a></section></article></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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Friday 12 January 2024 04:22">Friday 12 January 2024</span>. Using Julia version 1.11.0-DEV.1248.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/internals/index.html

@@ -11,4 +11,4 @@
     foreground: #ff0000</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/StyledStrings.jl/blob/3fab35e63140dccd4f8c28819d19049825d10e1b/src/faces.jl#L557-L571">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="StyledStrings.loaduserfaces!" href="#StyledStrings.loaduserfaces!"><code>StyledStrings.loaduserfaces!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">loaduserfaces!(faces::Dict{String, Any})</code></pre><p>For each face specified in <code>Dict</code>, load it to <code>FACES</code><code>.current</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/StyledStrings.jl/blob/3fab35e63140dccd4f8c28819d19049825d10e1b/src/faces.jl#L586-L590">source</a></section><section><div><pre><code class="language-julia hljs">loaduserfaces!(tomlfile::String)</code></pre><p>Load all faces declared in the Faces.toml file <code>tomlfile</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/StyledStrings.jl/blob/3fab35e63140dccd4f8c28819d19049825d10e1b/src/faces.jl#L607-L611">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="StyledStrings.resetfaces!" href="#StyledStrings.resetfaces!"><code>StyledStrings.resetfaces!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">resetfaces!()</code></pre><p>Reset the current global face dictionary to the default value.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/StyledStrings.jl/blob/3fab35e63140dccd4f8c28819d19049825d10e1b/src/faces.jl#L368-L372">source</a></section><section><div><pre><code class="language-julia hljs">resetfaces!(name::Symbol)</code></pre><p>Reset the face <code>name</code> to its default value, which is returned.</p><p>If the face <code>name</code> does not exist, nothing is done and <code>nothing</code> returned. In the unlikely event that the face <code>name</code> does not have a default value, it is deleted, a warning message is printed, and <code>nothing</code> returned.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/StyledStrings.jl/blob/3fab35e63140dccd4f8c28819d19049825d10e1b/src/faces.jl#L384-L392">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="StyledStrings.termcolor" href="#StyledStrings.termcolor"><code>StyledStrings.termcolor</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">termcolor(io::IO, color::SimpleColor, category::Char)</code></pre><p>Print to <code>io</code> the SGR code to set the <code>category</code>&#39;s slot to <code>color</code>, where <code>category</code> is set as follows:</p><ul><li><code>&#39;3&#39;</code> sets the foreground color</li><li><code>&#39;4&#39;</code> sets the background color</li><li><code>&#39;5&#39;</code> sets the underline color</li></ul><p>If <code>color</code> is a <code>SimpleColor{Symbol}</code>, the value should be a a member of <code>ANSI_4BIT_COLORS</code>. Any other value will cause the color to be reset.</p><p>If <code>color</code> is a <code>SimpleColor{RGBTuple}</code> and <code>get_have_truecolor()</code> returns true, 24-bit color is used. Otherwise, an 8-bit approximation of <code>color</code> is used.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/StyledStrings.jl/blob/3fab35e63140dccd4f8c28819d19049825d10e1b/src/io.jl#L92-L106">source</a></section><section><div><pre><code class="language-julia hljs">termcolor(io::IO, ::Nothing, category::Char)</code></pre><p>Print to <code>io</code> the SGR code to reset the color for <code>category</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/StyledStrings.jl/blob/3fab35e63140dccd4f8c28819d19049825d10e1b/src/io.jl#L131-L135">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="StyledStrings.termcolor24bit" href="#StyledStrings.termcolor24bit"><code>StyledStrings.termcolor24bit</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">termcolor24bit(io::IO, color::RGBTuple, category::Char)</code></pre><p>Print to <code>io</code> the 24-bit SGR color code to set the <code>category</code>8 slot to <code>color</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/StyledStrings.jl/blob/3fab35e63140dccd4f8c28819d19049825d10e1b/src/io.jl#L80-L84">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="StyledStrings.termcolor8bit" href="#StyledStrings.termcolor8bit"><code>StyledStrings.termcolor8bit</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">termcolor8bit(io::IO, color::RGBTuple, category::Char)</code></pre><p>Print to <code>io</code> the best 8-bit SGR color code that sets the <code>category</code> color to be close to <code>color</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/StyledStrings.jl/blob/3fab35e63140dccd4f8c28819d19049825d10e1b/src/io.jl#L50-L55">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="StyledStrings.withfaces" href="#StyledStrings.withfaces"><code>StyledStrings.withfaces</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">withfaces(f, kv::Pair...)</code></pre><p>Execute <code>f</code> with <code>FACES</code><code>.current</code> temporarily modified by zero or more <code>:name =&gt; val</code> arguments <code>kv</code>. <code>withfaces</code> is generally used via the <code>withfaces(kv...) do ... end</code> syntax. A value of <code>nothing</code> can be used to temporarily unset an face (if if has been set). When <code>withfaces</code> returns, the original <code>FACES</code><code>.current</code> has been restored.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; withfaces(:yellow =&gt; Face(foreground=:red), :green =&gt; :blue) do
            println(styled&quot;{yellow:red} and {green:blue} mixed make {magenta:purple}&quot;)
        end
-red and blue mixed make purple</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/StyledStrings.jl/blob/3fab35e63140dccd4f8c28819d19049825d10e1b/src/faces.jl#L404-L421">source</a></section><section><div><pre><code class="language-julia hljs">withfaces(f, altfaces::Dict{Symbol, Face})</code></pre><p>Execute <code>f</code> with <code>FACES</code><code>.current</code> temporarily swapped out with <code>altfaces</code> When <code>withfaces</code> returns, the original <code>FACES</code><code>.current</code> has been restored.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/StyledStrings.jl/blob/3fab35e63140dccd4f8c28819d19049825d10e1b/src/faces.jl#L436-L441">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« StyledStrings</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Saturday 30 December 2023 02:44">Saturday 30 December 2023</span>. Using Julia version 1.11.0-DEV.1168.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+red and blue mixed make purple</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/StyledStrings.jl/blob/3fab35e63140dccd4f8c28819d19049825d10e1b/src/faces.jl#L404-L421">source</a></section><section><div><pre><code class="language-julia hljs">withfaces(f, altfaces::Dict{Symbol, Face})</code></pre><p>Execute <code>f</code> with <code>FACES</code><code>.current</code> temporarily swapped out with <code>altfaces</code> When <code>withfaces</code> returns, the original <code>FACES</code><code>.current</code> has been restored.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/StyledStrings.jl/blob/3fab35e63140dccd4f8c28819d19049825d10e1b/src/faces.jl#L436-L441">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« StyledStrings</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Friday 12 January 2024 04:22">Friday 12 January 2024</span>. Using Julia version 1.11.0-DEV.1248.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>