Skip to content

Commit

Permalink
build based on 5ef5c71
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jun 14, 2024
1 parent 682b7f8 commit faf0bd2
Show file tree
Hide file tree
Showing 8 changed files with 57 additions and 57 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.4","generation_timestamp":"2024-06-14T16:36:26","documenter_version":"1.4.1"}}
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-06-14T17:25:17","documenter_version":"1.4.1"}}
2 changes: 1 addition & 1 deletion development/getting_started/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
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 <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>These Typst documents were generated from Julia using <code>show</code> with the <code>text/typst</code> MIME type and compiled using a <code>TypstCommand</code>. Each row corresponds to a method of <a href="../manual/extensions/#Typstry.show_typst-Tuple{Any, Union{Date, DateTime, Time}}"><code>show_typst</code></a>. Sequential documents correspond to package <a href="../manual/extensions/#extensions_extensions">Extensions</a>.</p><p><img src="../assets/Typstry_examples.svg" alt="Typstry.jl examples"/> <img src="../assets/Dates_examples.svg" alt="Dates.jl examples"/> <img src="../assets/LaTeXStrings_examples.svg" alt="LaTeXStrings.jl examples"/> <img src="../assets/Markdown_examples.svg" alt="Markdown.jl examples"/></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="Friday 14 June 2024 16:36">Friday 14 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
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>These Typst documents were generated from Julia using <code>show</code> with the <code>text/typst</code> MIME type and compiled using a <code>TypstCommand</code>. Each row corresponds to a method of <a href="../manual/extensions/#Typstry.show_typst-Tuple{Any, Union{Date, DateTime, Time}}"><code>show_typst</code></a>. Sequential documents correspond to package <a href="../manual/extensions/#extensions_extensions">Extensions</a>.</p><p><img src="../assets/Typstry_examples.svg" alt="Typstry.jl examples"/> <img src="../assets/Dates_examples.svg" alt="Dates.jl examples"/> <img src="../assets/LaTeXStrings_examples.svg" alt="LaTeXStrings.jl examples"/> <img src="../assets/Markdown_examples.svg" alt="Markdown.jl examples"/></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="Friday 14 June 2024 17:25">Friday 14 June 2024</span>. Using Julia version 1.10.4.</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>Support rendering in more environments<ul><li>IJulia.jl</li><li>Quarto?</li><li>REPL Unicode?</li><li>Other?</li></ul></li><li>Default <code>auto::Mode</code>?<ul><li>Automatically determine the Typst syntactic context</li><li>Use a tree-sitter grammar or jll package</li></ul></li><li>Documenter.jl backend and docstrings<ul><li>Requires Typst to <a href="https://github.com/typst/typst/issues/721">output HTML</a></li></ul></li><li>Implement Typst formatting for more types<ul><li><code>Base</code><ul><li><code>AbstractDict</code></li><li><code>AbstractIrrational</code></li><li><code>AbstractSet</code></li><li><code>Enum</code></li><li><code>Expr</code></li><li><code>Mode</code></li><li><code>Symbol</code></li></ul></li><li>Package extensions<ul><li>Standard Library<ul><li>Dates.jl<ul><li><code>Period</code> –&gt; <code>duration</code></li></ul></li><li>LinearAlgebra.jl</li></ul></li></ul></li><li>A symbolic <code>TypstFunction</code>?<ul><li>May faciliate Julia to Typst transpilation</li><li>Examples<ul><li><code>TypstString(TypstFunction(eval, :(1//2); mode = code)) == typst&quot;eval(&quot;(1 / 2)&quot;, mode: \&quot;code\&quot;)&quot;</code></li><li><code>TypstString(TypstFunction(*, :a, :b; mode = math)) == typst&quot;(a) (b)&quot;</code></li></ul></li></ul></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><li><a href="https://github.com/JuliaPlots/MakieTeX.jl">MakieTeX.jl</a><ul><li>Supports Typstry.jl</li></ul></li><li><a href="https://github.com/MichaelHatherly/MathJaxRenderer.jl">MathJaxRenderer.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="Friday 14 June 2024 16:36">Friday 14 June 2024</span>. Using Julia version 1.10.4.</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>Support rendering in more environments<ul><li>IJulia.jl</li><li>Quarto?</li><li>REPL Unicode?</li><li>Other?</li></ul></li><li>Default <code>auto::Mode</code>?<ul><li>Automatically determine the Typst syntactic context</li><li>Use a tree-sitter grammar or jll package</li></ul></li><li>Documenter.jl backend and docstrings<ul><li>Requires Typst to <a href="https://github.com/typst/typst/issues/721">output HTML</a></li></ul></li><li>Implement Typst formatting for more types<ul><li><code>Base</code><ul><li><code>AbstractDict</code></li><li><code>AbstractIrrational</code></li><li><code>AbstractSet</code></li><li><code>Enum</code></li><li><code>Expr</code></li><li><code>Mode</code></li><li><code>Symbol</code></li></ul></li><li>Package extensions<ul><li>Standard Library<ul><li>Dates.jl<ul><li><code>Period</code> –&gt; <code>duration</code></li></ul></li><li>LinearAlgebra.jl</li></ul></li></ul></li><li>A symbolic <code>TypstFunction</code>?<ul><li>May faciliate Julia to Typst transpilation</li><li>Examples<ul><li><code>TypstString(TypstFunction(eval, :(1//2); mode = code)) == typst&quot;eval(&quot;(1 / 2)&quot;, mode: \&quot;code\&quot;)&quot;</code></li><li><code>TypstString(TypstFunction(*, :a, :b; mode = math)) == typst&quot;(a) (b)&quot;</code></li></ul></li></ul></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><li><a href="https://github.com/JuliaPlots/MakieTeX.jl">MakieTeX.jl</a><ul><li>Supports Typstry.jl</li></ul></li><li><a href="https://github.com/MichaelHatherly/MathJaxRenderer.jl">MathJaxRenderer.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="Friday 14 June 2024 17:25">Friday 14 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit faf0bd2

Please sign in to comment.