Literate

Literate is a package for Literate Programming. The main purpose is to facilitate writing Julia examples/tutorials that can be included in your package documentation.

Literate can generate markdown pages (for e.g. Documenter.jl), and Jupyter notebooks, from the same source file. There is also an option to "clean" the source from all metadata, and produce a pure Julia script. Using a single source file for multiple purposes reduces maintenance, and makes sure your different output formats are synced with each other.

This README was generated directly from this source file running these commands from the package root of Literate.jl:

using Literate
Literate.markdown("examples/README.jl", "."; flavor = Literate.CommonMarkFlavor())

Related packages

• Weave.jl can generate Jupyter notebooks, HTML, or PDF directly from a Markdown format containing Julia code blocks.
• Quarto can generate Jupyter notebooks, HTML, or PDF directly from a Markdown format containing Julia code blocks, and also works with R and Python. (Note that Literate.jl can produce Quarto input markdown files (.qmd) as well.)

---

This page was generated using Literate.jl.