Weave.jl/doc/src/index.md

39 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2016-12-12 23:19:33 +01:00
# Weave.jl - Scientific Reports Using Julia
2020-03-04 11:23:48 +01:00
This is the documentation of [Weave.jl](http://github.com/mpastell/weave.jl).
Weave is a scientific report generator/literate programming tool for Julia.
It resembles
[Pweave](http://mpastell.com/pweave),
[knitr](https://yihui.org/knitr/),
[R Markdown](https://rmarkdown.rstudio.com/),
and [Sweave](https://stat.ethz.ch/R-manual/R-patched/library/utils/doc/Sweave.pdf).
2015-01-02 16:05:40 +01:00
**Current features**
2020-04-01 12:04:55 +02:00
- Publish markdown directly to HTML and PDF using Julia or [Pandoc](https://pandoc.org/MANUAL.html)
- Execute code as in terminal or in a unit of code chunk
- Capture [Plots.jl](https://github.com/JuliaPlots/Plots.jl) or [Gadfly.jl](https://github.com/GiovineItalia/Gadfly.jl) figures
- Supports various input format: Markdown, [Noweb](https://www.cs.tufts.edu/~nr/noweb/), [Jupyter Notebook](https://jupyter.org/), 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
2016-04-20 11:26:22 +02:00
2020-03-06 12:52:09 +01:00
![Weave in Juno demo](https://user-images.githubusercontent.com/40514306/76081328-32f41900-5fec-11ea-958a-375f77f642a2.png)
2020-05-16 10:52:17 +02:00
## Index
2016-04-20 11:26:22 +02:00
```@contents
2020-05-16 10:52:17 +02:00
Pages = [
"index.md",
"getting_started.md",
"usage.md",
"publish.md",
"chunk_options.md",
2020-05-24 19:05:48 +02:00
"header.md",
2020-05-16 10:52:17 +02:00
"notebooks.md",
"function_index.md",
]
```