<htmllang="en"><head><metacharset="UTF-8"/><metaname="viewport"content="width=device-width, initial-scale=1.0"/><title>Getting started · Weave.jl</title><linkrel="canonical"href="http://weavejl.mpastell.com/stable/getting_started/"/><linkhref="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono"rel="stylesheet"type="text/css"/><linkhref="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/fontawesome.min.css"rel="stylesheet"type="text/css"/><linkhref="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/solid.min.css"rel="stylesheet"type="text/css"/><linkhref="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/brands.min.css"rel="stylesheet"type="text/css"/><linkhref="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/katex.min.css"rel="stylesheet"type="text/css"/><script>documenterBaseURL=".."</script><scriptsrc="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js"data-main="../assets/documenter.js"></script><scriptsrc="../siteinfo.js"></script><scriptsrc="../../versions.js"></script><linkclass="docs-theme-link"rel="stylesheet"type="text/css"href="../assets/themes/documenter-dark.css"data-theme-name="documenter-dark"/><linkclass="docs-theme-link"rel="stylesheet"type="text/css"href="../assets/themes/documenter-light.css"data-theme-name="documenter-light"data-theme-primary/><scriptsrc="../assets/themeswap.js"></script></head><body><divid="documenter"><navclass="docs-sidebar"><divclass="docs-package-name"><spanclass="docs-autofit">Weave.jl</span></div><formclass="docs-search"action="../search/"><inputclass="docs-search-query"id="documenter-search-query"name="q"type="text"placeholder="Search docs"/></form><ulclass="docs-menu"><li><aclass="tocitem"href="../">Weave.jl - Scientific Reports Using Julia</a></li><liclass="is-active"><aclass="tocitem"href>Getting started</a></li><li><aclass="tocitem"href="../usage/">Using Weave</a></li><li><aclass="tocitem"href="../publish/">Publishing to HTML and PDF</a></li><li><aclass="tocitem"href="../header/">Header Configuration</a></li><li><aclass="tocitem"href="../chunk_options/">Chunk Options</a></li><li><aclass="tocitem"href="../notebooks/">Working with Jupyter notebooks</a></li><li><aclass="tocitem"href="../function_index/">Function index</a></li></ul><divclass="docs-version-selector field has-addons"><divclass="control"><spanclass="docs-label button is-static is-size-7">Version</span></div><divclass="docs-selector control is-expanded"><divclass="select is-fullwidth is-size-7"><selectid="documenter-version-selector"></select></div></div></div></nav><divclass="docs-main"><headerclass="docs-navbar"><navclass="breadcrumb"><ulclass="is-hidden-mobile"><liclass="is-active"><ahref>Getting started</a></li></ul><ulclass="is-hidden-tablet"><liclass="is-active"><ahref>Getting started</a></li></ul></nav><divclass="docs-right"><aclass="docs-edit-link"href="https://github.com/JunoLab/Weave.jl/blob/master/doc/src/getting_started.md"title="Edit on GitHub"><spanclass="docs-icon fab"></span><spanclass="docs-label is-hidden-touch">Edit on GitHub</span></a><aclass="docs-settings-button fas fa-cog"id="documenter-settings-button"href="#"title="Settings"></a><aclass="docs-sidebar-button fa fa-bars is-hidden-desktop"id="documenter-sidebar-button"href="#"></a></div></header><articleclass="content"id="documenter-page"><h1id="Getting-started-1"><aclass="docs-heading-anchor"href="#Getting-started-1">Getting started</a><aclass="docs-heading-anchor-permalink"href="#Getting-started-1"title="Permalink"></a></h1><p>The best way to get started using Weave.jl is to look at the example input and output documents. Examples for different formats are included in the package's <ahref="https://github.com/JunoLab/Weave.jl/tree/master/examples"><code>examples</code></a> directory.</p><p>First have a look at source document using markdown code chunks and <ahref="https://github.com/JuliaPlots/Plots.jl">Plots.jl</a> for figures:</p><p>All the different format docu
weave(filename; doctype = "pandoc", out_path = :pwd)</code></pre><divclass="admonition is-category-tips"><headerclass="admonition-header">Tips</header><divclass="admonition-body"><p><code>Weave.EXAMPLE_FOLDER</code> points to <ahref="https://github.com/JunoLab/Weave.jl/tree/master/examples">the <code>examples</code> directory</a>.</p></div></div></article><navclass="docs-footer"><aclass="docs-footer-prevpage"href="../">« Weave.jl - Scientific Reports Using Julia</a><aclass="docs-footer-nextpage"href="../usage/">Using Weave »</a></nav></div><divclass="modal"id="documenter-settings"><divclass="modal-background"></div><divclass="modal-card"><headerclass="modal-card-head"><pclass="modal-card-title">Settings</p><buttonclass="delete"></button></header><sectionclass="modal-card-body"><p><labelclass="label">Theme</label><divclass="select"><selectid="documenter-themepicker"><optionvalue="documenter-light">documenter-light</option><optionvalue="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <ahref="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <spanclass="colophon-date"title="Saturday 23 May 2020 17:58">Saturday 23 May 2020</span>. Using Julia version 1.4.1.</p></section><footerclass="modal-card-foot"></footer></div></div></div></body></html>