Documentation | Build Status |
---|---|
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 multiple outputs from a single source file: Markdown pages (for e.g. Documenter.jl), Jupyter notebooks, and Pluto notebooks. 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())
This page was generated using Literate.jl.