Literate.jl/CHANGELOG.md

Literate.jl changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

2.9.0 - 2021-07-09

Added

• Added "Franklin flavored" markdown output for usage with [Franklin] (https://franklinjl.org/). Enable by passing the flavor keyword argument:

  Literate.markdown(...; flavor = Literate.FranklinFlavor())
  

  (#146, #147, #156)

• Added "Documenter flavored" markdown output as a replacement for documenter=true, and "CommonMark flavored" markdown output as a replacement for documenter=false. Enable by passing the flavor keyword argument:

  Literate.markdown(...; flavor = Literate.DocumenterFlavor())
  Literate.markdown(...; flavor = Literate.CommonMarkFlavor())
  

  (#159)

• Added option to use multiline markdown strings (md""" ... """) as markdown sections. To enable, pass mdstrings=true. (#152, #149)

Changed

• The default code fence for markdown output have been changed to 4 (instead of 3) backticks to allow input files with 3 backticks, which is common in e.g. docstrings or multiline Cmd. (#144, #145)
• Replacement of Documenter-style @ref and @id elements are now removed unconditionally instead of conditionally based on the (now deprecated) documenter keyword argument. (#159)

Deprecated

• The documenter keyword argument has been deprecated. For Literate.markdown the the replacement is to use flavor = Literate.DocumenterFlavor() or flavor = Literate.CommonMarkFlavor() as appropriate (see above). For Literate.notebook and Literate.script the option is now unused (see above regarding @ref and @id), and no replacement is necessary. (#159)

2.8 - 2021-01-19

Added

• Execution of notebooks now capture output of display(x) and display(mime, x) (ceff7a3).

2.7 - 2021-09-12

Added

• Multiline-style Julia comments (#= ... =#) can now be used for markdown input (dc409d0).

2.6 - 2020-08-15

Added

• New end-of-line token #hide which filters out the line after execution in Literate.markdown(...; execute=true) (6d1aec9).
• Markdown execution now captures the text/markdown MIME (e08ca0a).

2.5 - 2020-05-14

Changed

• The output directory now defaults to pwd() (2ba316a).

2.4 - 2020-04-23

Added

• Markdown output can now be executed and the result included in the output by pasing execute=true to Literate.markdown. Currently captures the following MIMEs: text/plain, image/png, and image/jpeg (7e89fdb).

2.3 - 2020-03-03

Added

• Filter tokens #md, #nb, and #jl, as well as their negated counterparts, can now be placed at the end of lines (b0806ed).

2.2 - 2019-11-26

Added

• Configuration can now be passed as a config::Dict keyword argument to the generators (0f9e836).
• Link macros now works when running on GitLab CI (4e71b15).
• Literate now supports more configuration for e.g. URL's that @__REPO_ROOT_URL__ and friends expand to (4e71b15).

2.1 - 2019-10-30

Added

• Link macros now works when running on GitHub Actions (cf2b552).

2.0 - 2019-07-19

Added

• Negated filter tokens (#!nb, #!md and #!jl) are now supported (1d02868).
• Notebook output now support cell metadata with the %%-format (0872a96).

Changed

• BREAKING The link macros @__REPO_ROOT_URL__, @__NBVIEWER_ROOT_URL__ and @__BINDER_ROOT_URL__ no longer include a trailing / (7af5414).
• BREAKING The (undocumented) feature of Documenter continued blocks now requires an explicit #+ chunk splitter (36e8c21).
• The link macros @__REPO_ROOT_URL__, @__NBVIEWER_ROOT_URL__ now expands to correct paths when documentation is built with DocumentationGenerator.jl (7af5414).

1.1 - 2019-04-05

Added

• New link macro @__BINDER_ROOT_URL__ for linking to notebooks mybinder.org (fa64dcd).

1.0 - 2019-03-06

First stable release of Literate.jl, see https://discourse.julialang.org/t/ann-literate-jl/10651 for release announcement.