r
/
Literate.jl
mirror of https://github.com/fredrikekre/Literate.jl
1
0
Fork 0
Code Releases Activity
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.
330 Commits
4 Branches
62 Tags
20 MiB
 
Tree: 5ea086c75e
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '5ea086c75e'
${ noResults }
Fredrik Ekre 5ea086c75e
Add formatting commit to blame ignore list 		12 months ago
.github Apply Runic formatting (#266) 12 months ago
docs Apply Runic formatting (#266) 12 months ago
examples Apply Runic formatting (#266) 12 months ago
src Apply Runic formatting (#266) 12 months ago
test Apply Runic formatting (#266) 12 months ago
.codecov.yml Consistent naming of CI configuration files. 7 years ago
.git-blame-ignore-revs Add formatting commit to blame ignore list 12 months ago
.gitignore Use a coverage project for code coverage submission. 7 years ago
CHANGELOG.md Set version to 2.20.1. 1 year ago
LICENSE.md Use IOCapture instead of withoutput (#124) 5 years ago
Project.toml Set version to 2.20.1. 1 year ago
README.md Apply Runic formatting (#266) 12 months 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", "."; 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.