You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Fredrik Ekre e2868d6af2 Update doc-building dependencies. 6 years ago
.github Run CI on Julia 1.4. 6 years ago
docs Update doc-building dependencies. 6 years ago
examples Add a note about how to limit display output in notebooks, fixes #61. 6 years ago
src Allow all filter tokens at the end of lines (#93) 6 years ago
test Allow all filter tokens at the end of lines (#93) 6 years ago
.appveyor.yml Run CI on Julia 1.4. 6 years ago
.codecov.yml Consistent naming of CI configuration files. 7 years ago
.gitignore Use a coverage project for code coverage submission. 7 years ago
.travis.yml Run CI on Julia 1.4. 6 years ago
CHANGELOG.md Add changelog for 2.3.0. 6 years ago
LICENSE.md s/Examples/Literate 8 years ago
Project.toml Set version to 2.3.0. 6 years ago
README.md Run README script. 6 years ago

README.md

Literate

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 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", "."; documenter=false)

This page was generated using Literate.jl.