Weave.jl/doc/src/getting_started.md

1.3 KiB

Getting started

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 packages examples directory.

First have a look at source document using markdown code chunks and Plots.jl for figures: FIR_design.jmd and then see the output in different formats:

!!! note Producing PDF output requires that you have XeLateX installed.

Add dependencies for the example if needed:

using Pkg; Pkg.add.(["Plots", "DSP"])

Weave the files to your working directory:

using Weave

# Julia markdown to HTML
weave(
  joinpath(dirname(pathof(Weave)), "../examples", "FIR_design.jmd");
  doctype = "md2html",
  out_path = :pwd
)

# Julia markdown to PDF
weave(
  joinpath(dirname(pathof(Weave)), "../examples", "FIR_design.jmd");
  doctype = "md2pdf",
  out_path = :pwd
)

# Julia markdown to Pandoc markdown
weave(
  joinpath(dirname(pathof(Weave)), "../examples", "FIR_design.jmd");
  doctype = "pandoc",
  out_path = :pwd
)