Skip to content

Commit

Permalink
build based on 42eea6b
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed May 30, 2024
1 parent b6acdb9 commit 515f256
Show file tree
Hide file tree
Showing 8 changed files with 65 additions and 62 deletions.
2 changes: 1 addition & 1 deletion development/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-05-30T17:03:06","documenter_version":"1.4.1"}}
{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-05-30T17:38:58","documenter_version":"1.4.1"}}
4 changes: 2 additions & 2 deletions development/getting_started/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
typst"3.141592653589793"

julia> typst"$ \(pi) approx \(pi; mode = code) $"
typst&quot;$ π approx 3.141592653589793 $&quot;</code></pre><h3 id="Commands"><a class="docs-heading-anchor" href="#Commands">Commands</a><a id="Commands-1"></a><a class="docs-heading-anchor-permalink" href="#Commands" title="Permalink"></a></h3><p>Use <a href="../manual/commands/#Typstry.render"><code>render</code></a> to quickly generate a Typst source file and compile it into a document.</p><pre><code class="language-julia-repl hljs">julia&gt; render(Any[true 1; 1.2 1 // 2]);</code></pre><p>A source file is compiled using a <a href="../manual/commands/#Typstry.TypstCommand"><code>TypstCommand</code></a> created using its constructor or <a href="../manual/commands/#Typstry.@typst_cmd"><code>@typst_cmd</code></a>.</p><pre><code class="language-julia-repl hljs">julia&gt; TypstCommand([&quot;help&quot;])
typst&quot;$ π approx 3.141592653589793 $&quot;</code></pre><h3 id="Commands"><a class="docs-heading-anchor" href="#Commands">Commands</a><a id="Commands-1"></a><a class="docs-heading-anchor-permalink" href="#Commands" title="Permalink"></a></h3><p>Use <a href="../manual/commands/#Typstry.render"><code>render</code></a> to easily generate a Typst source file and compile it into a document.</p><pre><code class="language-julia-repl hljs">julia&gt; render(Any[true 1; 1.2 1 // 2]);</code></pre><p>Compile source files by <code>run</code>ning <a href="../manual/commands/#Typstry.TypstCommand"><code>TypstCommand</code></a> created using its constructor or <a href="../manual/commands/#Typstry.@typst_cmd"><code>@typst_cmd</code></a>.</p><pre><code class="language-julia-repl hljs">julia&gt; TypstCommand([&quot;help&quot;])
typst`help`

julia&gt; run(typst`compile input.typ output.pdf`);</code></pre><h2 id="Examples"><a class="docs-heading-anchor" href="#Examples">Examples</a><a id="Examples-1"></a><a class="docs-heading-anchor-permalink" href="#Examples" title="Permalink"></a></h2><p>This Typst source file was generated from Julia using <code>show</code> with the <code>text/typst</code> MIME type and compiled using a <code>TypstCommand</code>.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>Although many of the values are rendered similarly across modes, the generated Typst source code may differ between them.</p></div></div><pre><code class="language-typst hljs">#import table: cell, header
Expand Down Expand Up @@ -79,4 +79,4 @@
&quot;TypstText([1, 2, 3, 4])&quot;, `TypstText`, [#[1, 2, 3, 4]], [[1, 2, 3, 4]], $[1, 2, 3, 4]$,
&quot;0xff&quot;, `Unsigned`, [#0xff], [#0xff], $#0xff$
)
</code></pre><p><img src="../assets/strings.svg" alt/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../tutorials/interface/">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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Thursday 30 May 2024 17:03">Thursday 30 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</code></pre><p><img src="../assets/strings.svg" alt/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../tutorials/interface/">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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Thursday 30 May 2024 17:38">Thursday 30 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion development/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@
typst`help`

julia&gt; addenv(typst`compile input.typ output.pdf`, &quot;TYPST_FONT_PATHS&quot; =&gt; julia_mono)
typst`compile input.typ output.pdf`</code></pre><h2 id="Features"><a class="docs-heading-anchor" href="#Features">Features</a><a id="Features-1"></a><a class="docs-heading-anchor-permalink" href="#Features" title="Permalink"></a></h2><h3 id="Strings"><a class="docs-heading-anchor" href="#Strings">Strings</a><a id="Strings-1"></a><a class="docs-heading-anchor-permalink" href="#Strings" title="Permalink"></a></h3><ul><li>Print Julia values in Typst format<ul><li>Specify Julia settings and Typst parameters</li><li>Implement formatting for custom types</li></ul></li><li>Construct Typst strings<ul><li>Interpolate formatted values</li><li>Render in Pluto.jl notebooks</li></ul></li></ul><h3 id="Commands"><a class="docs-heading-anchor" href="#Commands">Commands</a><a id="Commands-1"></a><a class="docs-heading-anchor-permalink" href="#Commands" title="Permalink"></a></h3><ul><li>Construct Typst commands</li><li>Render documents using the Typst compiler<ul><li>Use the <a href="https://github.com/cormullion/juliamono">JuliaMono</a> typeface</li></ul></li></ul><h3 id="Planned"><a class="docs-heading-anchor" href="#Planned">Planned</a><a id="Planned-1"></a><a class="docs-heading-anchor-permalink" href="#Planned" title="Permalink"></a></h3><ul><li>Implement Typst formatting for more types<ul><li><code>Base</code></li><li>Standard Library</li><li>Package extensions</li></ul></li><li>Support rendering in more environments<ul><li>IJulia.jl</li><li>Quarto?</li><li>REPL Unicode?</li><li>Other?</li></ul></li></ul><h2 id="Related-Packages"><a class="docs-heading-anchor" href="#Related-Packages">Related Packages</a><a id="Related-Packages-1"></a><a class="docs-heading-anchor-permalink" href="#Related-Packages" title="Permalink"></a></h2><h3 id="Typst"><a class="docs-heading-anchor" href="#Typst">Typst</a><a id="Typst-1"></a><a class="docs-heading-anchor-permalink" href="#Typst" title="Permalink"></a></h3><ul><li><a href="https://github.com/emanuel-kopp/Labelyst.jl">Labelyst.jl</a></li><li><a href="https://github.com/PumasAI/SummaryTables.jl">SummaryTables.jl</a></li><li><a href="https://github.com/onecalfman/TypstGenerator.jl">TypstGenerator.jl</a></li><li><a href="https://github.com/JuliaBinaryWrappers/Typst_jll.jl">Typst_jll.jl</a></li></ul><h3 id="LaTeX"><a class="docs-heading-anchor" href="#LaTeX">LaTeX</a><a id="LaTeX-1"></a><a class="docs-heading-anchor-permalink" href="#LaTeX" title="Permalink"></a></h3><ul><li><a href="https://github.com/korsbo/Latexify.jl">Latexify.jl</a></li><li><a href="https://github.com/JuliaStrings/LaTeXStrings.jl">LaTeXStrings.jl</a></li><li><a href="https://github.com/scheinerman/LatexPrint.jl">LatexPrint.jl</a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="getting_started/">Getting Started »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Thursday 30 May 2024 17:03">Thursday 30 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
typst`compile input.typ output.pdf`</code></pre><h2 id="Features"><a class="docs-heading-anchor" href="#Features">Features</a><a id="Features-1"></a><a class="docs-heading-anchor-permalink" href="#Features" title="Permalink"></a></h2><h3 id="Strings"><a class="docs-heading-anchor" href="#Strings">Strings</a><a id="Strings-1"></a><a class="docs-heading-anchor-permalink" href="#Strings" title="Permalink"></a></h3><ul><li>Print Julia values in Typst format<ul><li>Specify Julia settings and Typst parameters</li><li>Implement formatting for custom types</li></ul></li><li>Construct Typst strings<ul><li>Interpolate formatted values</li><li>Render in Pluto.jl notebooks</li></ul></li></ul><h3 id="Commands"><a class="docs-heading-anchor" href="#Commands">Commands</a><a id="Commands-1"></a><a class="docs-heading-anchor-permalink" href="#Commands" title="Permalink"></a></h3><ul><li>Construct Typst commands</li><li>Render documents using the Typst compiler<ul><li>Use the <a href="https://github.com/cormullion/juliamono">JuliaMono</a> typeface</li></ul></li></ul><h3 id="Planned"><a class="docs-heading-anchor" href="#Planned">Planned</a><a id="Planned-1"></a><a class="docs-heading-anchor-permalink" href="#Planned" title="Permalink"></a></h3><ul><li>Implement Typst formatting for more types<ul><li><code>Base</code></li><li>Standard Library</li><li>Package extensions</li></ul></li><li>Support rendering in more environments<ul><li>IJulia.jl</li><li>Quarto?</li><li>REPL Unicode?</li><li>Other?</li></ul></li></ul><h2 id="Related-Packages"><a class="docs-heading-anchor" href="#Related-Packages">Related Packages</a><a id="Related-Packages-1"></a><a class="docs-heading-anchor-permalink" href="#Related-Packages" title="Permalink"></a></h2><h3 id="Typst"><a class="docs-heading-anchor" href="#Typst">Typst</a><a id="Typst-1"></a><a class="docs-heading-anchor-permalink" href="#Typst" title="Permalink"></a></h3><ul><li><a href="https://github.com/emanuel-kopp/Labelyst.jl">Labelyst.jl</a></li><li><a href="https://github.com/PumasAI/SummaryTables.jl">SummaryTables.jl</a></li><li><a href="https://github.com/onecalfman/TypstGenerator.jl">TypstGenerator.jl</a></li><li><a href="https://github.com/JuliaBinaryWrappers/Typst_jll.jl">Typst_jll.jl</a></li></ul><h3 id="LaTeX"><a class="docs-heading-anchor" href="#LaTeX">LaTeX</a><a id="LaTeX-1"></a><a class="docs-heading-anchor-permalink" href="#LaTeX" title="Permalink"></a></h3><ul><li><a href="https://github.com/korsbo/Latexify.jl">Latexify.jl</a></li><li><a href="https://github.com/JuliaStrings/LaTeXStrings.jl">LaTeXStrings.jl</a></li><li><a href="https://github.com/scheinerman/LatexPrint.jl">LatexPrint.jl</a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="getting_started/">Getting Started »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Thursday 30 May 2024 17:38">Thursday 30 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 515f256

Please sign in to comment.