Skip to content

Commit

Permalink
build based on b33e55c
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 30, 2023
1 parent ddd16c8 commit 334cb7e
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-30T20:29:48","documenter_version":"1.1.2"}}
{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-30T20:59:41","documenter_version":"1.1.2"}}
2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@
))
""";

julia&gt; render(document);</code></pre><p><img src="assets/showcase.png" alt="Showcase document"/></p><h2 id="Related-Projects"><a class="docs-heading-anchor" href="#Related-Projects">Related Projects</a><a id="Related-Projects-1"></a><a class="docs-heading-anchor-permalink" href="#Related-Projects" title="Permalink"></a></h2><ul><li><a href="https://github.com/onecalfman/TypstGenerator.jl">TypstGenerator.jl</a></li><li><a href="https://github.com/JuliaStrings/LaTeXStrings.jl">LaTeXStrings.jl</a></li><li><a href="https://github.com/korsbo/Latexify.jl">Latexify.jl</a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="manual/">Manual »</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.1.2 on <span class="colophon-date" title="Monday 30 October 2023 20:29">Monday 30 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
julia&gt; render(document);</code></pre><p><img src="assets/showcase.png" alt="Showcase document"/></p><h2 id="Related-Projects"><a class="docs-heading-anchor" href="#Related-Projects">Related Projects</a><a id="Related-Projects-1"></a><a class="docs-heading-anchor-permalink" href="#Related-Projects" title="Permalink"></a></h2><ul><li><a href="https://github.com/onecalfman/TypstGenerator.jl">TypstGenerator.jl</a></li><li><a href="https://github.com/JuliaStrings/LaTeXStrings.jl">LaTeXStrings.jl</a></li><li><a href="https://github.com/korsbo/Latexify.jl">Latexify.jl</a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="manual/">Manual »</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.1.2 on <span class="colophon-date" title="Monday 30 October 2023 20:59">Monday 30 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
10 changes: 5 additions & 5 deletions dev/manual/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
&quot;\$\$x&quot;

julia&gt; typst&quot;\\&quot;
&quot;\\&quot;</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jakobjpeters/Typstry.jl/blob/742eaf8daf36f409fbcc22669de55c338449af4e/src/Typstry.jl#L21-L47">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="Typstry.@typst_cmd" href="#Typstry.@typst_cmd"><code>Typstry.@typst_cmd</code></a> — <span class="docstring-category">Macro</span></header><section><div><pre><code class="language-julia hljs">@typst_cmd(s)</code></pre><p>Return a <code>Cmd</code> such that <code>run(typst`$s`)</code> is equivalent to <code>shell&gt; typst $s</code>.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>This macro does not yet support interpolation.</p></div></div><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; run(typst`help`);
&quot;\\&quot;</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jakobjpeters/Typstry.jl/blob/b33e55cf873c63b53f6a768e1250c3df28eea5d8/src/Typstry.jl#L21-L47">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="Typstry.@typst_cmd" href="#Typstry.@typst_cmd"><code>Typstry.@typst_cmd</code></a> — <span class="docstring-category">Macro</span></header><section><div><pre><code class="language-julia hljs">@typst_cmd(s)</code></pre><p>Return a <code>Cmd</code> such that <code>run(typst`$s`)</code> is equivalent to <code>shell&gt; typst $s</code>.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>This macro does not yet support interpolation.</p></div></div><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; run(typst`help`);
The Typst compiler

Usage: typst [OPTIONS] &lt;COMMAND&gt;
Expand All @@ -32,7 +32,7 @@

julia&gt; write(&quot;input.typ&quot;, typst&quot;$x ^ 2$&quot;);

julia&gt; run(typst`compile input.typ output.pdf`);</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jakobjpeters/Typstry.jl/blob/742eaf8daf36f409fbcc22669de55c338449af4e/src/Typstry.jl#L87-L121">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="Typstry.typst" href="#Typstry.typst"><code>Typstry.typst</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">typst(s)</code></pre><p>Equivalent to <code>shell&gt; typst $s</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; typst(&quot;help&quot;);
julia&gt; run(typst`compile input.typ output.pdf`);</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jakobjpeters/Typstry.jl/blob/b33e55cf873c63b53f6a768e1250c3df28eea5d8/src/Typstry.jl#L87-L121">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="Typstry.typst" href="#Typstry.typst"><code>Typstry.typst</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">typst(s)</code></pre><p>Equivalent to <code>shell&gt; typst $s</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; typst(&quot;help&quot;);
The Typst compiler

Usage: typst [OPTIONS] &lt;COMMAND&gt;
Expand All @@ -53,8 +53,8 @@

julia&gt; write(&quot;input.typ&quot;, typst&quot;$x ^ 2$&quot;);

julia&gt; typst(&quot;compile input.typ output.pdf&quot;);</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jakobjpeters/Typstry.jl/blob/742eaf8daf36f409fbcc22669de55c338449af4e/src/Typstry.jl#L126-L156">source</a></section><section><div><pre><code class="language-julia hljs">typst(xs...)</code></pre><p>Equivalent to <code>typst(join(xs, &quot; &quot;))</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; write(&quot;input.typ&quot;, typst&quot;$x ^ 2$&quot;);
julia&gt; typst(&quot;compile input.typ output.pdf&quot;);</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jakobjpeters/Typstry.jl/blob/b33e55cf873c63b53f6a768e1250c3df28eea5d8/src/Typstry.jl#L126-L156">source</a></section><section><div><pre><code class="language-julia hljs">typst(xs...)</code></pre><p>Equivalent to <code>typst(join(xs, &quot; &quot;))</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; write(&quot;input.typ&quot;, typst&quot;$x ^ 2$&quot;);

julia&gt; typst(&quot;compile&quot;, &quot;input.typ&quot;, &quot;output.pdf&quot;);</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jakobjpeters/Typstry.jl/blob/742eaf8daf36f409fbcc22669de55c338449af4e/src/Typstry.jl#L159-L170">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="Typstry.render" href="#Typstry.render"><code>Typstry.render</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">render(::String; input = &quot;input.typ&quot;, output = &quot;output.pdf&quot;, open = true)</code></pre><p>Render the given string to a document.</p><p>This function generates two files. The first is the <code>input</code>, which contains the Typst document. The second is the <code>output</code>, which is rendered from the <code>input</code> using Typst&#39;s compile function.</p><p>The document format is inferred by the file extension of <code>output</code>. The available formats are <code>pdf</code>, <code>png</code>, and <code>svg</code>.</p><p>If <code>open</code>, <code>output</code> will be opened using the default viewer.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>This is designed to generate a document with little effort. For more advanced useage, see <a href="#Typstry.typst"><code>typst</code></a>.</p></div></div><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; render(typst&quot;$x ^ 2$&quot;);
julia&gt; typst(&quot;compile&quot;, &quot;input.typ&quot;, &quot;output.pdf&quot;);</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jakobjpeters/Typstry.jl/blob/b33e55cf873c63b53f6a768e1250c3df28eea5d8/src/Typstry.jl#L159-L170">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="Typstry.render" href="#Typstry.render"><code>Typstry.render</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">render(::String; input = &quot;input.typ&quot;, output = &quot;output.pdf&quot;, open = true)</code></pre><p>Render the given string to a document.</p><p>This function generates two files. The first is the <code>input</code>, which contains the Typst document. The second is the <code>output</code>, which is rendered from the <code>input</code> using Typst&#39;s compile function.</p><p>The document format is inferred by the file extension of <code>output</code>. The available formats are <code>pdf</code>, <code>png</code>, and <code>svg</code>.</p><p>If <code>open</code>, <code>output</code> will be opened using the default viewer.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>This is designed to generate a document with little effort. For more advanced useage, see <a href="#Typstry.typst"><code>typst</code></a>.</p></div></div><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; render(typst&quot;$x ^ 2$&quot;);

julia&gt; render([1, 2, 3, 4]);</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jakobjpeters/Typstry.jl/blob/742eaf8daf36f409fbcc22669de55c338449af4e/src/Typstry.jl#L173-L197">source</a></section><section><div><pre><code class="language-julia hljs">render(elements...; delimeter = &quot; \\n&quot;, kwargs...)</code></pre><p>Equivalent to <code>render(join(xs, delimeter; kwargs...))</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; render(&quot;The area of a circle is&quot;, typst&quot;$A = pi dot r ^ 2$&quot;; delimeter = &quot; &quot;);</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jakobjpeters/Typstry.jl/blob/742eaf8daf36f409fbcc22669de55c338449af4e/src/Typstry.jl#L203-L212">source</a></section></article><h2 id="Internals"><a class="docs-heading-anchor" href="#Internals">Internals</a><a id="Internals-1"></a><a class="docs-heading-anchor-permalink" href="#Internals" title="Permalink"></a></h2><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="Typstry.interpolate" href="#Typstry.interpolate"><code>Typstry.interpolate</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">interpolate(xs, s, start, stop)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jakobjpeters/Typstry.jl/blob/742eaf8daf36f409fbcc22669de55c338449af4e/src/Typstry.jl#L9-L11">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="Typstry.typst_cmd" href="#Typstry.typst_cmd"><code>Typstry.typst_cmd</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">typst_cmd(s)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jakobjpeters/Typstry.jl/blob/742eaf8daf36f409fbcc22669de55c338449af4e/src/Typstry.jl#L14-L16">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</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.1.2 on <span class="colophon-date" title="Monday 30 October 2023 20:29">Monday 30 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
julia&gt; render([1, 2, 3, 4]);</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jakobjpeters/Typstry.jl/blob/b33e55cf873c63b53f6a768e1250c3df28eea5d8/src/Typstry.jl#L173-L197">source</a></section><section><div><pre><code class="language-julia hljs">render(elements...; delimeter = &quot; \\n&quot;, kwargs...)</code></pre><p>Equivalent to <code>render(join(xs, delimeter; kwargs...))</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; render(&quot;The area of a circle is&quot;, typst&quot;$A = pi dot r ^ 2$&quot;; delimeter = &quot; &quot;);</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jakobjpeters/Typstry.jl/blob/b33e55cf873c63b53f6a768e1250c3df28eea5d8/src/Typstry.jl#L203-L212">source</a></section></article><h2 id="Internals"><a class="docs-heading-anchor" href="#Internals">Internals</a><a id="Internals-1"></a><a class="docs-heading-anchor-permalink" href="#Internals" title="Permalink"></a></h2><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="Typstry.interpolate" href="#Typstry.interpolate"><code>Typstry.interpolate</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">interpolate(xs, s, start, stop)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jakobjpeters/Typstry.jl/blob/b33e55cf873c63b53f6a768e1250c3df28eea5d8/src/Typstry.jl#L9-L11">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="Typstry.typst_cmd" href="#Typstry.typst_cmd"><code>Typstry.typst_cmd</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">typst_cmd(s)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jakobjpeters/Typstry.jl/blob/b33e55cf873c63b53f6a768e1250c3df28eea5d8/src/Typstry.jl#L14-L16">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</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.1.2 on <span class="colophon-date" title="Monday 30 October 2023 20:59">Monday 30 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 comments on commit 334cb7e

Please sign in to comment.