mirrors
/
Weave.jl
mirror of https://github.com/mpastell/Weave.jl
1
0
Fork 0
Code Issues Releases Wiki Activity
365 Commits
14 Branches
45 Tags
11 MiB
Julia 85.1%
CSS 7.9%
Jupyter Notebook 2.2%
TeX 1.9%
Smarty 1.5%
Other 1.4%
 
 
 
 
 
 
Go to file
Matti Pastell 6c2f0a7bb5 No need to patch latex writer in 0.6 2017-01-04 19:56:28 +02:00
bin Improved error handling for Pandoc 2016-04-28 16:11:45 +03:00
doc Correct doc version 2016-12-29 17:30:31 +02:00
examples Fix CRLF in rest of the files 2016-12-23 10:54:48 +02:00
src No need to patch latex writer in 0.6 2017-01-04 19:56:28 +02:00
templates Fix to tex template 2016-12-17 00:25:56 +02:00
test Add test to caching 2016-12-28 01:12:53 +02:00
.gitattributes Fix handling of \r #72 2016-12-22 21:40:07 +02:00
.gitignore Fix CRLF in rest of the files 2016-12-23 10:54:48 +02:00
.travis.yml Preparing for 0.2 release 2016-10-30 19:11:13 +02:00
LICENSE.md Renamed package to Weave,jl as discussed in mpastell:pull-request/54b50af2 2014-12-08 10:31:03 +02:00
NEWS.md Update release notes 2016-12-19 21:33:40 +02:00
README.md Fix CRLF in rest of the files 2016-12-23 10:54:48 +02:00
REQUIRE Fix CRLF in rest of the files 2016-12-23 10:54:48 +02:00
appveyor.yml Install PyPlot on appveyor 2016-12-20 12:40:56 -08:00

README.md

Weave

Build Status Build status Coverage Status

Weave is a scientific report generator/literate programming tool for Julia. It resembles Pweave, Knitr, rmarkdown and Sweave.

You can write your documentation and code in input document using Noweb, Markdown, Script syntax and use weave function to execute to document to capture results and figures.

Current features

  • Noweb, markdown or script syntax for input documents.
  • Execute code as terminal or "script" chunks.
  • Capture Plots, Gadfly, PyPlot and Winston figures.
  • Supports LaTex, Pandoc, Github markdown, MultiMarkdown, Asciidoc and reStructuredText output
  • Publish markdown directly to html and pdf using Julia or Pandoc markdown.
  • Simple caching of results
  • Convert to and from IJulia notebooks

Usage

Run from julia using Gadfly for plots:

using Weave
weave(Pkg.dir("Weave","examples","gadfly_sample.mdw"))

If you have Pandoc installed you can also weave directly to html and pdf.

weave(Pkg.dir("Weave","examples","gadfly_md_sample.jmd"), informat="markdown",
  out_path = :pwd, doctype = "md2html")

Weave code and output

Documentation

Documenter.jl with MKDocs generated documentation:

Editor support

I have made language-weave package for Atom to do the syntax highlighting correctly.

Noweb documents work well with ESS as well, to set doc-mode for .mdw files to markdown and code to Julia you can do:

(defun mdw-mode ()
       (ess-noweb-mode)
       (setq ess-noweb-default-code-mode 'ess-julia-mode)
       (setq ess-noweb-doc-mode 'markdown-mode))

(setq auto-mode-alist (append (list (cons "\\.mdw$" 'mdw-mode))
                   auto-mode-alist))

Contributing

I will probably add new features to Weave when I need them myself or if they are requested and not too difficult to implement. You can contribute by opening issues on Github or implementing things yourself and making a pull request. I'd also appreciate example documents written using Weave to add to examples.

Contributors

You can see the list of contributors on Github: https://github.com/mpastell/Weave.jl/graphs/contributors. Thanks for the important additions, fixes and comments.