-
-
Notifications
You must be signed in to change notification settings - Fork 63
/
Copy pathREADME.jl
33 lines (29 loc) · 1.99 KB
/
README.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# # Literate
#
# [](https://fredrikekre.github.io/Literate.jl/)
# [](https://github.com/fredrikekre/Literate.jl/actions/workflows/Test.yml)
# [](https://codecov.io/github/fredrikekre/Literate.jl)
# [](https://github.com/fredrikekre/Runic.jl)
#
# Literate is a package for [Literate Programming](https://en.wikipedia.org/wiki/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](https://github.com/JuliaDocs/Documenter.jl)), and
# [Jupyter notebooks](http://jupyter.org/), 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](https://github.com/fredrikekre/Literate.jl/blob/master/examples/README.jl)
# running these commands from the package root of Literate.jl:
using Literate
Literate.markdown("examples/README.jl", "."; flavor = Literate.CommonMarkFlavor())
# ### Related packages
#
# - [Weave.jl](https://github.com/JunoLab/Weave.jl) can generate Jupyter notebooks, HTML, or
# PDF directly from a Markdown format containing Julia code blocks.
# - [Quarto](https://quarto.org) 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.)