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 05d0b42dbf Define include in the sandbox module, fix #31. 7 years ago
docs Use a doc project for documentation building 7 years ago
examples Generate README.md from examples/README.jl as an example. 7 years ago
src Define include in the sandbox module, fix #31. 7 years ago
test Define include in the sandbox module, fix #31. 7 years ago
.codecov.yml change to comment=off (#2) 8 years ago
.gitignore Use a coverage project for code coverage submission. 7 years ago
.travis.yml Actually deploy coverage. 7 years ago
LICENSE.md s/Examples/Literate 8 years ago
Project.toml Set version to 1.0.1, bump REQUIRE 7 years ago
README.md Generate README.md from examples/README.jl as an example. 7 years ago
REQUIRE Set version to 1.0.1, bump REQUIRE 7 years ago
appveyor.yml CI: don't test on 0.7. 7 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.