Skip to content

Latest commit

 

History

History
278 lines (244 loc) · 14.3 KB

CHANGELOG.md

File metadata and controls

278 lines (244 loc) · 14.3 KB

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.

2.14.1 - 2023-08-04

Fixed

  • Update generated EditURL to use a relative path instead and let Documenter figure out the remote repository. This is required for Documenter version 1, but works also on Documenter 0.27. (#219)

2.14.0 - 2022-09-22

Changed

  • Image filenames resulting from executing markdown files (Literate.markdown(...; execute=true)) have changed from a number based on the hash of the source block to the format {name}-{blocknumber}.(svg|png|...). (#204, #205)

2.13.4 - 2022-06-03

Fixed

  • Automatic head branch detection (introduced in version 2.11.0) caused a performance regression since the git remote show command takes ~1 second. For documentation builds with many literate files this caused significant slowdowns, which is particularly annoying when doing iterative buils with eg. LiveServer.jl. Literate now caches the remote head branch on a per-repo basis, so the 1 second delay should only be noticed on the first run of the first file in a repo. As noted in the changelog entry for 2.11.0 it is also possible to specify the head branch by passing the edit_commit keyword argument. Doing so will now completely skip the slow git command. (8054d26)

2.13.3 - 2022-05-21

Fixed

  • Update remote HEAD branch detection to use addenv instead of setenv such that e.g. ssh-agent variables are available to the git command. Also set GIT_SSH_COMMAND='ssh -o "BatchMode yes"' to supress prompts when using ssh. (#197)

2.13.2 - 2022-04-22

Fixed

  • Set current working directory for markdown execution to the output directory, just like notebook execution. (#195)
  • Set the apparent source file to the output file for markdown and notebook execution. (#195)

2.13.1 - 2022-04-12

Fixed

  • Disable git terminal prompt when detecting remote HEAD branch. (#194)

2.13.0 - 2022-02-18

Changed

  • "Markdown stdlib-style" inline math (e.g. ``f(x) = x^2``) is now replaced with "notebook style" math ($f(x) = x^2$) for notebook output. This is already the case for display math (```math). (#116, #190)

Fixed

  • Lines with trailing #hide are not shown in output of Markdown execution with Documenter flavor. (#166, #188)

2.12.1 - 2022-02-10

Fixed

  • Make sure Markdown execution picks up new definitions of display methods (by running in the latest "world age"). (#187)

2.12.0 - 2022-02-01

Changed

  • User input configurations can now be AbstractDicts instead of just Dicts. (#185, #186)

2.11.0 - 2022-01-25

Added

  • Literate now tries to figure out the branch/commit that EditURL should point to automatically instead of always defaulting to "master". For typical setups the auto-detection should be sufficient, but you can also set it explicitly by passing edit_commit, for example edit_commit = "main". (#179, #184)

2.10.0 - 2022-01-24

Added

  • Markdown execution now also support image/svg+xml. (#182, #183)

2.9.4 - 2021-10-18

Fixed

  • Fix multiline comment support for \r\n line endings. (#171, #172)

2.9.3 - 2021-09-01

Fixed

  • Fix named @examples from Literate.markdown to not contain spaces even if the source filename does. (#168, #169)

2.9.2 - 2021-08-16

Fixed

  • Fix multiline comment support for \r\n line endings. (#165, #167)

2.9.1 - 2021-07-30

Fixed

  • Automatic URLs from @__NBVIEWER_ROOT_URL__ and @__BINDER_ROOT_URL__ now follow the convention used in Documenter.jl to ignore build version information. (#162, #163)

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.