r
/
Literate.jl
mirror of https://github.com/fredrikekre/Literate.jl
1
0
Fork 0
Code Releases Activity
Browse Source

Readme

pull/120/head
Fredrik Ekre 4 years ago
parent
874b758e82
commit
442eea1786
2 changed files with 14 additions and 12 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 13
      README.md
  2. 13
      examples/README.jl

13
README.md
Unescape View File

@ -8,12 +8,13 @@ Literate is a package for [Literate Programming](https://en.wikipedia.org/wiki/L
The main purpose is to facilitate writing Julia examples/tutorials that can be included in The main purpose is to facilitate writing Julia examples/tutorials that can be included in
your package documentation. your package documentation.
Literate can generate markdown pages Literate can generate multiple outputs from a single source file: Markdown pages
(for e.g. [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl)), and (for e.g. [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl)),
[Jupyter notebooks](http://jupyter.org/), from the same source file. There is also [Jupyter notebooks](http://jupyter.org/), and
an option to "clean" the source from all metadata, and produce a pure Julia script. [Pluto notebooks](https://github.com/fonsp/Pluto.jl).
Using a single source file for multiple purposes reduces maintenance, and makes sure There is also an option to "clean" the source from all metadata, and produce a
your different output formats are synced with each other. 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 README was generated directly from
[this source file](https://github.com/fredrikekre/Literate.jl/blob/master/examples/README.jl) [this source file](https://github.com/fredrikekre/Literate.jl/blob/master/examples/README.jl)

13
examples/README.jl
Unescape View File

@ -8,12 +8,13 @@
# The main purpose is to facilitate writing Julia examples/tutorials that can be included in # The main purpose is to facilitate writing Julia examples/tutorials that can be included in
# your package documentation. # your package documentation.
# Literate can generate markdown pages # Literate can generate multiple outputs from a single source file: Markdown pages
# (for e.g. [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl)), and # (for e.g. [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl)),
# [Jupyter notebooks](http://jupyter.org/), from the same source file. There is also # [Jupyter notebooks](http://jupyter.org/), and
# an option to "clean" the source from all metadata, and produce a pure Julia script. # [Pluto notebooks](https://github.com/fonsp/Pluto.jl).
# Using a single source file for multiple purposes reduces maintenance, and makes sure # There is also an option to "clean" the source from all metadata, and produce a
# your different output formats are synced with each other. # 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 README was generated directly from
# [this source file](https://github.com/fredrikekre/Literate.jl/blob/master/examples/README.jl) # [this source file](https://github.com/fredrikekre/Literate.jl/blob/master/examples/README.jl)

Write Preview
Loading…
Cancel
Save