mirror of https://github.com/mpastell/Weave.jl
3 lines
8.5 KiB
HTML
3 lines
8.5 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Weave.jl - Scientific Reports Using Julia · Weave.jl</title><link rel="canonical" href="http://weavejl.mpastell.com/stable/"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/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="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"/><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"><div class="docs-package-name"><span class="docs-autofit">Weave.jl</span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Weave.jl - Scientific Reports Using Julia</a><ul class="internal"><li><a class="tocitem" href="#Index"><span>Index</span></a></li></ul></li><li><a class="tocitem" href="getting_started/">Getting started</a></li><li><a class="tocitem" href="usage/">Using Weave</a></li><li><a class="tocitem" href="publish/">Publishing to HTML and PDF</a></li><li><a class="tocitem" href="chunk_options/">Chunk Options</a></li><li><a class="tocitem" href="header/">Header Configuration</a></li><li><a class="tocitem" href="notebooks/">Working with Jupyter notebooks</a></li><li><a class="tocitem" href="function_index/">Function index</a></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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Weave.jl - Scientific Reports Using Julia</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Weave.jl - Scientific Reports Using Julia</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/JunoLab/Weave.jl/blob/master/doc/src/index.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Weave.jl-Scientific-Reports-Using-Julia"><a class="docs-heading-anchor" href="#Weave.jl-Scientific-Reports-Using-Julia">Weave.jl - Scientific Reports Using Julia</a><a id="Weave.jl-Scientific-Reports-Using-Julia-1"></a><a class="docs-heading-anchor-permalink" href="#Weave.jl-Scientific-Reports-Using-Julia" title="Permalink"></a></h1><p>This is the documentation of <a href="http://github.com/mpastell/weave.jl">Weave.jl</a>. Weave is a scientific report generator/literate programming tool for Julia. It resembles <a href="http://mpastell.com/pweave">Pweave</a>, <a href="https://yihui.org/knitr/">knitr</a>, <a href="https://rmarkdown.rstudio.com/">R Markdown</a>, and <a href="https://stat.ethz.ch/R-manual/R-patched/library/utils/doc/Sweave.pdf">Sweave</a>.</p><p><strong>Current features</strong></p><ul><li>Publish markdown directly to HTML and PDF using Julia or <a href="https://pandoc.org/MANUAL.html">Pandoc</a></li><li>Execute code as in terminal or in a unit of code chunk</li><li>Capture <a href="https://github.com/JuliaPlots/Plots.jl">Plots.jl</a> or <a href="https://github.com/GiovineItalia/Gadfly.jl">Gadfly.jl</a> figures</li><li>Supports various input format: Markdown, <a href="https://www.cs.tufts.edu/~nr/noweb/">Noweb</a>, <a href="https://jupyter.org/">Jupyter Notebook</a>, and ordinal Julia script</li><li>Conversions between those input formats</li><li>Supports various output document formats: HTML, PDF, GitHub markdown, Jupyter Notebook, MultiMarkdown, Asciidoc and reStructuredText</li><li>Simple caching of results</li></ul><p><img src="https://user-images.githubusercontent.com/40514306/76081328-32f41900-5fec-11ea-958a-375f77f642a2.png" alt="Weave in Juno demo"/></p><h2 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h2><ul><li><a href="#Weave.jl-Scientific-Reports-Using-Julia">Weave.jl - Scientific Reports Using Julia</a></li><ul><li><a href="#Index">Index</a></li></ul><li><a href="getting_started/#Getting-started">Getting started</a></li><li><a href="usage/#Using-Weave">Using Weave</a></li><ul><li><a href="usage/#weave"><code>weave</code></a></li><li><a href="usage/#tangle"><code>tangle</code></a></li><li><a href="usage/#Supported-Output-Formats">Supported Output Formats</a></li><li><a href="usage/#document-syntax">Document Syntax</a></li><li><a href="usage/#Configuration-via-YAML-Header">Configuration via YAML Header</a></li><li><a href="usage/#Passing-Runtime-Arguments-to-Documents">Passing Runtime Arguments to Documents</a></li><li><a href="usage/#include_weave"><code>include_weave</code></a></li></ul><li><a href="publish/#Publishing-to-HTML-and-PDF">Publishing to HTML and PDF</a></li><ul><li><a href="publish/#Templates">Templates</a></li><li><a href="publish/#Supported-Markdown-syntax">Supported Markdown syntax</a></li></ul><li><a href="chunk_options/#chunk-options">Chunk Options</a></li><ul><li><a href="chunk_options/#Syntax">Syntax</a></li><li><a href="chunk_options/#Weave-Chunk-Options">Weave Chunk Options</a></li><li><a href="chunk_options/#Default-Chunk-Options">Default Chunk Options</a></li></ul><li><a href="header/#Header-Configuration">Header Configuration</a></li><ul><li><a href="header/#Document-Metadata">Document Metadata</a></li><li><a href="header/#Configuration-Options">Configuration Options</a></li><li><a href="header/#Format-Specific-Options">Format Specific Options</a></li></ul><li><a href="notebooks/#Working-with-Jupyter-notebooks">Working with Jupyter notebooks</a></li><ul><li><a href="notebooks/#Weaving-from-Jupyter-notebooks">Weaving from Jupyter notebooks</a></li><li><a href="notebooks/#Output-to-Jupyter-notebooks">Output to Jupyter notebooks</a></li><li><a href="notebooks/#Converting-between-formats">Converting between formats</a></li></ul><li><a href="function_index/#Function-index">Function index</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="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> on <span class="colophon-date" title="Friday 2 October 2020 19:47">Friday 2 October 2020</span>. Using Julia version 1.5.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
|