You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Sebastian Pfitzner e10aaefd94
Merge pull request #469 from laborg/master
8 months ago
.github fixes #400 3 years ago
bin rm unncessary `Symbol` spec: 3 years ago
doc HTML( 2 years ago
examples update links 3 years ago
paper Updated citation #85 7 years ago
src Merge pull request #462 from NicholasWMRitchie/nwmr 8 months ago
stylesheets more consistent templates names, move stylesheets into ./stylesheets 3 years ago
templates Reapply improvements to the tex rendering pipeline 3 years ago
test relax dataframe displayed row counting 8 months ago
.gitattributes Fix handling of \r #72 7 years ago
.gitignore 🔥 3 years ago
.travis.yml version 0.10.5 3 years ago update LICENSE 3 years ago version 0.10.6 3 years ago
Project.toml update relocatablefolders.jl dependency 8 months ago Mention Literate.jl in 9 months ago


CI codecov

Weave is a scientific report generator/literate programming tool for the Julia programming language. It resembles Pweave, knitr, R Markdown, and Sweave.

You can write your documentation and code in input document using Markdown, Noweb or ordinal Julia script syntax, and then use weave function to execute code and generate an output document while capturing results and figures.

Current features

  • Publish markdown directly to HTML and PDF using Julia or Pandoc
  • Execute code as in terminal or in a unit of code chunk
  • Capture Plots.jl or Gadfly.jl figures
  • Supports various input format: Markdown, Noweb, Jupyter Notebook, and ordinal Julia script
  • Conversions between those input formats
  • Supports various output document formats: HTML, PDF, GitHub markdown, Jupyter Notebook, MultiMarkdown, Asciidoc and reStructuredText
  • Simple caching of results

Citing Weave: Pastell, Matti. 2017. Weave.jl: Scientific Reports Using Julia. The Journal of Open Source Software.

Weave in Juno demo


You can install the latest release using Julia package manager:

using Pkg


using Weave

# add depencies for the example
using Pkg; Pkg.add(["Plots", "DSP"])

filename = normpath(Weave.EXAMPLE_FOLDER, "FIR_design.jmd")
weave(filename, out_path = :pwd)

If you have LaTeX installed you can also weave directly to pdf.

filename = normpath(Weave.EXAMPLE_FOLDER, "FIR_design.jmd")
weave(filename, out_path = :pwd, doctype = "md2pdf")

NOTE: Weave.EXAMPLE_FOLDER just points to examples directory.


Documenter.jl with MKDocs generated documentation:

Editor support

Install language-weave to add Weave support to Juno. It allows running code from Weave documents with usual keybindings and allows preview of html and pdf output.

The Julia extension for Visual Studio Code adds Weave support to Visual Studio Code.


You can contribute to this package by opening issues on GitHub or implementing things yourself and making a pull request. We'd also appreciate more example documents written using Weave.


You can see the list of contributors on GitHub: . Thanks for the important additions, fixes and comments.

Example projects using Weave

  • Literate.jl can be used to generate Markdown and Jupyter notebooks directly from Julia source files with markdown in comments.