Skip to content

Commit

Permalink
build based on 61d1aab
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed May 30, 2024
1 parent 9c07035 commit b6acdb9
Show file tree
Hide file tree
Showing 9 changed files with 77 additions and 78 deletions.
2 changes: 1 addition & 1 deletion development/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-05-30T15:08:06","documenter_version":"1.4.1"}}
{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-05-30T17:03:06","documenter_version":"1.4.1"}}
8 changes: 5 additions & 3 deletions development/getting_started/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Getting Started · Typstry.jl</title><meta name="title" content="Getting Started · Typstry.jl"/><meta property="og:title" content="Getting Started · Typstry.jl"/><meta property="twitter:title" content="Getting Started · Typstry.jl"/><meta name="description" content="Documentation for Typstry.jl."/><meta property="og:description" content="Documentation for Typstry.jl."/><meta property="twitter:description" content="Documentation for Typstry.jl."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="Typstry.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">Typstry.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li class="is-active"><a class="tocitem" href>Getting Started</a><ul class="internal"><li><a class="tocitem" href="#Basics"><span>Basics</span></a></li><li><a class="tocitem" href="#Examples"><span>Examples</span></a></li></ul></li><li><span class="tocitem">Tutorials</span><ul><li><a class="tocitem" href="../tutorials/interface/">Interface</a></li></ul></li><li><span class="tocitem">Manual</span><ul><li><a class="tocitem" href="../manual/strings/">Strings</a></li><li><a class="tocitem" href="../manual/commands/">Commands</a></li><li><a class="tocitem" href="../manual/internals/">Internals</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Getting Started</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Getting Started</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/jakobjpeters/Typstry.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/jakobjpeters/Typstry.jl/blob/main/docs/src/getting_started.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Getting-Started"><a class="docs-heading-anchor" href="#Getting-Started">Getting Started</a><a id="Getting-Started-1"></a><a class="docs-heading-anchor-permalink" href="#Getting-Started" title="Permalink"></a></h1><h2 id="Basics"><a class="docs-heading-anchor" href="#Basics">Basics</a><a id="Basics-1"></a><a class="docs-heading-anchor-permalink" href="#Basics" 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><p>Print Julia values in <a href="../#Typst"><code>Typst</code></a> format using <code>show</code> with the <code>text/typst</code> MIME type.</p><pre><code class="language-julia-repl hljs">julia&gt; show(stdout, &quot;text/typst&quot;, Typst(π))
π</code></pre><p>Some methods use an <code>IOContext</code> to configure the formatting.</p><pre><code class="language-julia-repl hljs">julia&gt; show(IOContext(stdout, :mode =&gt; code), &quot;text/typst&quot;, Typst(π))
3.141592653589793</code></pre><p>Instead of printing, construct a <a href="../manual/strings/#Typstry.TypstString"><code>TypstString</code></a>.</p><pre><code class="language-julia-repl hljs">julia&gt; TypstString(π)
3.141592653589793</code></pre><p>Instead of printing, create a <a href="../manual/strings/#Typstry.TypstString"><code>TypstString</code></a> using its constructor or <a href="../manual/strings/#Typstry.@typst_str"><code>@typst_str</code></a> with formatted interpolation.</p><pre><code class="language-julia-repl hljs">julia&gt; TypstString(π)
typst&quot;π&quot;

julia&gt; TypstString(π; mode = code)
typst&quot;3.141592653589793&quot;</code></pre><p>Alternatively, use <a href="../manual/strings/#Typstry.@typst_str"><code>@typst_str</code></a> to construct a <code>TypstString</code> with formatted interpolation.</p><pre><code class="language-julia-repl hljs">julia&gt; typst&quot;$ \(pi) approx \(pi; mode = code) $&quot;
typst&quot;3.141592653589793&quot;

julia&gt; typst&quot;$ \(pi) approx \(pi; mode = code) $&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 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`help`

Expand Down Expand Up @@ -77,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 15:08">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: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>
Loading

0 comments on commit b6acdb9

Please sign in to comment.