|
|
<!DOCTYPE html> |
|
|
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>9. Changelog · Literate.jl</title><meta name="title" content="9. Changelog · Literate.jl"/><meta property="og:title" content="9. Changelog · Literate.jl"/><meta property="twitter:title" content="9. Changelog · Literate.jl"/><meta name="description" content="Documentation for Literate.jl."/><meta property="og:description" content="Documentation for Literate.jl."/><meta property="twitter:description" content="Documentation for Literate.jl."/><meta property="og:url" content="https://fredrikekre.github.io/Literate.jl/v2/changelog/"/><meta property="twitter:url" content="https://fredrikekre.github.io/Literate.jl/v2/changelog/"/><link rel="canonical" href="https://fredrikekre.github.io/Literate.jl/v2/changelog/"/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script><link href="../assets/custom.css" rel="stylesheet" type="text/css"/><link href="../assets/favicon.ico" rel="icon" type="image/x-icon"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.png" alt="Literate.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">Literate.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../"><strong>1.</strong> Introduction</a></li><li><a class="tocitem" href="../fileformat/"><strong>2.</strong> File format</a></li><li><a class="tocitem" href="../pipeline/"><strong>3.</strong> Processing pipeline</a></li><li><a class="tocitem" href="../outputformats/"><strong>4.</strong> Output formats</a></li><li><a class="tocitem" href="../customprocessing/"><strong>5.</strong> Custom pre- and post-processing</a></li><li><a class="tocitem" href="../documenter/"><strong>6.</strong> Interaction with Documenter.jl</a></li><li><a class="tocitem" href="../tips/"><strong>7.</strong> Tips and tricks</a></li><li><a class="tocitem" href="../generated/example/"><strong>8.</strong> Example</a></li><li class="is-active"><a class="tocitem" href><strong>9.</strong> Changelog</a><ul class="internal"><li><a class="tocitem" href="#[v2.21.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.21.0)-2025-11-19"><span>v2.21.0 - 2025-11-19</span></a></li><li><a class="tocitem" href="#[v2.20.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.20.1)-2024-10-17"><span>v2.20.1 - 2024-10-17</span></a></li><li><a class="tocitem" href="#[v2.20.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.20.0)-2024-10-16"><span>v2.20.0 - 2024-10-16</span></a></li><li><a class="tocitem" href="#[v2.19.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.19.1)-2024-09-13"><span>v2.19.1 - 2024-09-13</span></a></li><li><a class="tocitem" href="#[v2.19.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.19.0)-2024-07-11"><span>v2.19.0 - 2024-07-11</span></a></li><li><a class="tocitem" href="#[v2.18.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.18.0)-2024-04-17"><span>v2.18.0 - 2024-04-17</span></a></li><li><a class="tocitem" href="#[v2.17.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.17.0)-2024-04-14"><span>v2.17.0 - 2024-04-14</span></a></li><li><a class="tocitem" href="#[v2.16.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.16.1)-2024-01-04"><span>v2.16.1 - 2024-01-04</span></a></li><li><a class="tocitem" href="#[v2.16.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.16.0)-2023-11-08"><span>v2.16.0 - 2023-11-08</span></a></li><li><a class="tocitem" href="#[v2.15.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.15.1)-2023-11-08"><span>v2.15.1 - 2023-11-08</span></a></li><li><a class="tocitem" href="#[v2.15.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.15.0)-2023-09-05"><span>v2.15.0 - 2023-09-05</span></a></li><li><a class="tocitem" href="#[v2.14.2](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.2)-2023-08-28"><span>v2.14.2 - 2023-08-28</span></a></li><li><a class="tocitem" href="#[v2.14.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.1)-2023-08-04"><span>v2.14.1 - 2023-08-04</span></a></li><li><a class="tocitem" href="#[v2.14.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.0)-2022-09-22"><span>v2.14.0 - 2022-09-22</span></a></li><li><a class="tocitem" href="#[v2.13.4](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.4)-2022-06-03"><span>v2.13.4 - 2022-06-03</span></a></li><li><a class="tocitem" href="#[v2.13.3](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.3)-2022-05-21"><span>v2.13.3 - 2022-05-21</span></a></li><li><a class="tocitem" href="#[v2.13.2](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.2)-2022-04-22"><span>v2.13.2 - 2022-04-22</span></a></li><li><a class="tocitem" href="#[v2.13.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.1)-2022-04-12"><span>v2.13.1 - 2022-04-12</span></a></li><li><a class="tocitem" href="#[v2.13.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.0)-2022-02-18"><span>v2.13.0 - 2022-02-18</span></a></li><li><a class="tocitem" href="#[v2.12.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.12.1)-2022-02-10"><span>v2.12.1 - 2022-02-10</span></a></li><li><a class="tocitem" href="#[v2.12.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.12.0)-2022-02-01"><span>v2.12.0 - 2022-02-01</span></a></li><li><a class="tocitem" href="#[v2.11.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.11.0)-2022-01-25"><span>v2.11.0 - 2022-01-25</span></a></li><li><a class="tocitem" href="#[v2.10.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.10.0)-2022-01-24"><span>v2.10.0 - 2022-01-24</span></a></li><li><a class="tocitem" href="#[v2.9.4](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.4)-2021-10-18"><span>v2.9.4 - 2021-10-18</span></a></li><li><a class="tocitem" href="#[v2.9.3](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.3)-2021-09-01"><span>v2.9.3 - 2021-09-01</span></a></li><li><a class="tocitem" href="#[v2.9.2](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.2)-2021-08-16"><span>v2.9.2 - 2021-08-16</span></a></li><li><a class="tocitem" href="#[v2.9.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.1)-2021-07-30"><span>v2.9.1 - 2021-07-30</span></a></li><li><a class="tocitem" href="#[v2.9.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.0)-2021-07-09"><span>v2.9.0 - 2021-07-09</span></a></li><li><a class="tocitem" href="#v2.8-2021-01-19"><span>v2.8 - 2021-01-19</span></a></li><li><a class="tocitem" href="#v2.7-2021-09-12"><span>v2.7 - 2021-09-12</span></a></li><li><a class="tocitem" href="#v2.6-2020-08-15"><span>v2.6 - 2020-08-15</span></a></li><li><a class="tocitem" href="#v2.5-2020-05-14"><span>v2.5 - 2020-05-14</span></a></li><li><a class="tocitem" href="#v2.4-2020-04-23"><span>v2.4 - 2020-04-23</span></a></li><li><a class="tocitem" href="#v2.3-2020-03-03"><span>v2.3 - 2020-03-03</span></a></li><li><a class="tocitem" href="#v2.2-2019-11-26"><span>v2.2 - 2019-11-26</span></a></li><li><a class="tocitem" href="#v2.1-2019-10-30"><span>v2.1 - 2019-10-30</span></a></li><li><a class="tocitem" href="#v2.0-2019-07-19"><span>v2.0 - 2019-07-19</span></a></li><li><a class="tocitem" href="#v1.1-2019-04-05"><span>v1.1 - 2019-04-05</span></a></li><li><a class="tocitem" href="#v1.0-2019-03-06"><span>v1.0 - 2019-03-06</span></a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href><strong>9.</strong> Changelog</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href><strong>9.</strong> Changelog</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/fredrikekre/Literate.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/fredrikekre/Literate.jl/blob/master/CHANGELOG.md" title="View source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="**9.**-Changelog"><a class="docs-heading-anchor" href="#**9.**-Changelog"><strong>9.</strong> Changelog</a><a id="**9.**-Changelog-1"></a><a class="docs-heading-anchor-permalink" href="#**9.**-Changelog" title="Permalink"></a></h1><p>All notable changes to this project will be documented in this file.</p><p>The format is based on <a href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>, and this project adheres to <a href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p><h2 id="[v2.21.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.21.0)-2025-11-19"><a class="docs-heading-anchor" href="#[v2.21.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.21.0)-2025-11-19"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.21.0">v2.21.0</a> - 2025-11-19</a><a id="[v2.21.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.21.0)-2025-11-19-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.21.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.21.0)-2025-11-19" title="Permalink"></a></h2><h3 id="Changed"><a class="docs-heading-anchor" href="#Changed">Changed</a><a id="Changed-1"></a><a class="docs-heading-anchor-permalink" href="#Changed" title="Permalink"></a></h3><ul><li>Allow IOCapture version 1. (<a href="https://github.com/fredrikekre/Literate.jl/issues/280">#280</a>)</li></ul><h2 id="[v2.20.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.20.1)-2024-10-17"><a class="docs-heading-anchor" href="#[v2.20.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.20.1)-2024-10-17"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.20.1">v2.20.1</a> - 2024-10-17</a><a id="[v2.20.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.20.1)-2024-10-17-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.20.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.20.1)-2024-10-17" title="Permalink"></a></h2><h3 id="Fixed"><a class="docs-heading-anchor" href="#Fixed">Fixed</a><a id="Fixed-1"></a><a class="docs-heading-anchor-permalink" href="#Fixed" title="Permalink"></a></h3><ul><li>Errors from code evaluation (with <code>continue_on_error = true</code>) are now properly displayed with <code>showerror</code>. (<a href="https://github.com/fredrikekre/Literate.jl/issues/261">#261</a>)</li></ul><h2 id="[v2.20.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.20.0)-2024-10-16"><a class="docs-heading-anchor" href="#[v2.20.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.20.0)-2024-10-16"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.20.0">v2.20.0</a> - 2024-10-16</a><a id="[v2.20.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.20.0)-2024-10-16-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.20.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.20.0)-2024-10-16" title="Permalink"></a></h2><h3 id="Added"><a class="docs-heading-anchor" href="#Added">Added</a><a id="Added-1"></a><a class="docs-heading-anchor-permalink" href="#Added" title="Permalink"></a></h3><ul><li><p>A new keyword argument configuration <code>continue_on_error::Bool = false</code> has been added which controls the behavior of code execution errors. By default (<code>continue_on_error = false</code>) execution errors are re-thrown by Literate (as before). If <code>continue_on_error = true</code> is set the error is used as the block result and execution continues with following blocks. (<a href="https://github.com/fredrikekre/Literate.jl/issues/201">#201</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/257">#257</a>)</p></li><li><p>Literate now replaces Documenter-style admonitions when generating notebook output (<a href="https://github.com/fredrikekre/Literate.jl/issues/259">#259</a>). Concretely,</p><pre><code class="nohighlight hljs"># !!! note |
|
|
# A note. |
|
|
|
|
|
# !!! warn "Warning title text" |
|
|
# A warning.</code></pre><p>is replaced with</p><pre><code class="nohighlight hljs"># > **Note** |
|
|
# > |
|
|
# > A note. |
|
|
|
|
|
# > **Warning title text** |
|
|
# > |
|
|
# > A warning.</code></pre></li></ul><h2 id="[v2.19.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.19.1)-2024-09-13"><a class="docs-heading-anchor" href="#[v2.19.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.19.1)-2024-09-13"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.19.1">v2.19.1</a> - 2024-09-13</a><a id="[v2.19.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.19.1)-2024-09-13-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.19.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.19.1)-2024-09-13" title="Permalink"></a></h2><h3 id="Fixed-2"><a class="docs-heading-anchor" href="#Fixed-2">Fixed</a><a class="docs-heading-anchor-permalink" href="#Fixed-2" title="Permalink"></a></h3><ul><li>Set <code>:SOURCE_PATH</code> in the task local storage to the output file when executing code so that recursive <code>include</code> works as expected. (<a href="https://github.com/fredrikekre/Literate.jl/issues/251">#251</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/252">#252</a>)</li></ul><h2 id="[v2.19.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.19.0)-2024-07-11"><a class="docs-heading-anchor" href="#[v2.19.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.19.0)-2024-07-11"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.19.0">v2.19.0</a> - 2024-07-11</a><a id="[v2.19.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.19.0)-2024-07-11-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.19.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.19.0)-2024-07-11" title="Permalink"></a></h2><h3 id="Changed-2"><a class="docs-heading-anchor" href="#Changed-2">Changed</a><a class="docs-heading-anchor-permalink" href="#Changed-2" title="Permalink"></a></h3><ul><li><code>Literate.markdown</code>, <code>Literate.notebook</code>, and <code>Literate.script</code> are marked as <code>public</code> in Julia version that support the <code>public</code> keyword. (<a href="https://github.com/fredrikekre/Literate.jl/issues/248">#248</a>)</li></ul><h2 id="[v2.18.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.18.0)-2024-04-17"><a class="docs-heading-anchor" href="#[v2.18.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.18.0)-2024-04-17"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.18.0">v2.18.0</a> - 2024-04-17</a><a id="[v2.18.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.18.0)-2024-04-17-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.18.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.18.0)-2024-04-17" title="Permalink"></a></h2><h3 id="Added-2"><a class="docs-heading-anchor" href="#Added-2">Added</a><a class="docs-heading-anchor-permalink" href="#Added-2" title="Permalink"></a></h3><ul><li>Literate will now remove <a href="https://github.com/JuliaDocs/DocumenterInterLinks.jl">DocumenterInterlinks.jl</a> <code>@extref</code> links similarly to how Documenter.jl <code>@ref</code> and <code>@id</code>'s are removed. (<a href="https://github.com/fredrikekre/Literate.jl/issues/245">#245</a>)</li></ul><h2 id="[v2.17.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.17.0)-2024-04-14"><a class="docs-heading-anchor" href="#[v2.17.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.17.0)-2024-04-14"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.17.0">v2.17.0</a> - 2024-04-14</a><a id="[v2.17.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.17.0)-2024-04-14-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.17.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.17.0)-2024-04-14" title="Permalink"></a></h2><h3 id="Added-3"><a class="docs-heading-anchor" href="#Added-3">Added</a><a class="docs-heading-anchor-permalink" href="#Added-3" title="Permalink"></a></h3><ul><li>Literate can now output <a href="https://quarto.org/">Quarto</a> notebooks (markdown documents with the <code>.qmd</code> file extension) by passing <code>flavor = Literate.QuartoFlavor()</code> to <code>Literate.markdown</code>. This feature is marked as experimental since it has not been widely tested and the Quarto-specific syntax may change before Literate version 3 depending on what the community wants or needs. (<a href="https://github.com/fredrikekre/Literate.jl/issues/199">#199</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/200">#200</a>)</li></ul><h2 id="[v2.16.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.16.1)-2024-01-04"><a class="docs-heading-anchor" href="#[v2.16.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.16.1)-2024-01-04"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.16.1">v2.16.1</a> - 2024-01-04</a><a id="[v2.16.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.16.1)-2024-01-04-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.16.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.16.1)-2024-01-04" title="Permalink"></a></h2><h3 id="Fixed-3"><a class="docs-heading-anchor" href="#Fixed-3">Fixed</a><a class="docs-heading-anchor-permalink" href="#Fixed-3" title="Permalink"></a></h3><ul><li>Fix removal of Documenter-style <code>@ref</code> links spanning multiple lines. (<a href="https://github.com/fredrikekre/Literate.jl/issues/224">#224</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/233">#233</a>)</li></ul><h2 id="[v2.16.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.16.0)-2023-11-08"><a class="docs-heading-anchor" href="#[v2.16.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.16.0)-2023-11-08"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.16.0">v2.16.0</a> - 2023-11-08</a><a id="[v2.16.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.16.0)-2023-11-08-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.16.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.16.0)-2023-11-08" title="Permalink"></a></h2><h3 id="Added-4"><a class="docs-heading-anchor" href="#Added-4">Added</a><a class="docs-heading-anchor-permalink" href="#Added-4" title="Permalink"></a></h3><ul><li>"Soft" scoping rules (see e.g. <a href="https://github.com/JuliaLang/SoftGlobalScope.jl">https://github.com/JuliaLang/SoftGlobalScope.jl</a>) are now available for code execution (markdown and notebook output). This is enabled by default for Jupyter notebook output (to mimic how the IJulia kernel works), and disabled otherwise. Soft scope rules can be enabled/disabled with the <code>softscope :: Bool</code> configuration variable. (<a href="https://github.com/fredrikekre/Literate.jl/issues/227">#227</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/230">#230</a>)</li></ul><h3 id="Changed-3"><a class="docs-heading-anchor" href="#Changed-3">Changed</a><a class="docs-heading-anchor-permalink" href="#Changed-3" title="Permalink"></a></h3><ul><li>The minimum Julia version requirement for Literate >= 2.16.0 is now 1.6.0 (from 1.0.0). (<a href="https://github.com/fredrikekre/Literate.jl/issues/230">#230</a>)</li></ul><h2 id="[v2.15.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.15.1)-2023-11-08"><a class="docs-heading-anchor" href="#[v2.15.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.15.1)-2023-11-08"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.15.1">v2.15.1</a> - 2023-11-08</a><a id="[v2.15.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.15.1)-2023-11-08-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.15.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.15.1)-2023-11-08" title="Permalink"></a></h2><h3 id="Fixed-4"><a class="docs-heading-anchor" href="#Fixed-4">Fixed</a><a class="docs-heading-anchor-permalink" href="#Fixed-4" title="Permalink"></a></h3><ul><li>Fix a bug where <code>Literate.markdown</code> with <code>execute=true</code> would (try to) output images in the wrong directory. This only occured when passing a relative output directory. (<a href="https://github.com/fredrikekre/Literate.jl/issues/228">#228</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/229">#229</a>)</li></ul><h2 id="[v2.15.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.15.0)-2023-09-05"><a class="docs-heading-anchor" href="#[v2.15.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.15.0)-2023-09-05"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.15.0">v2.15.0</a> - 2023-09-05</a><a id="[v2.15.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.15.0)-2023-09-05-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.15.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.15.0)-2023-09-05" title="Permalink"></a></h2><h3 id="Added-5"><a class="docs-heading-anchor" href="#Added-5">Added</a><a class="docs-heading-anchor-permalink" href="#Added-5" title="Permalink"></a></h3><ul><li>Documenter style <code>@raw html</code> blocks are automatically handled in Jupyter notebook output (similar to how Documenter style <code></code>`<code>math</code> blocks are rewritten to <code>$$</code> blocks). (<a href="https://github.com/fredrikekre/Literate.jl/issues/222">#222</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/223">#223</a>)</li></ul><h2 id="[v2.14.2](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.2)-2023-08-28"><a class="docs-heading-anchor" href="#[v2.14.2](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.2)-2023-08-28"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.2">v2.14.2</a> - 2023-08-28</a><a id="[v2.14.2](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.2)-2023-08-28-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.14.2](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.2)-2023-08-28" title="Permalink"></a></h2><h3 id="Fixed-5"><a class="docs-heading-anchor" href="#Fixed-5">Fixed</a><a class="docs-heading-anchor-permalink" href="#Fixed-5" title="Permalink"></a></h3><ul><li>Remove double newline in <code>Literate.script</code> output. (<a href="https://github.com/fredrikekre/Literate.jl/issues/221">#221</a>)</li></ul><h2 id="[v2.14.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.1)-2023-08-04"><a class="docs-heading-anchor" href="#[v2.14.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.1)-2023-08-04"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.1">v2.14.1</a> - 2023-08-04</a><a id="[v2.14.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.1)-2023-08-04-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.14.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.1)-2023-08-04" title="Permalink"></a></h2><h3 id="Fixed-6"><a class="docs-heading-anchor" href="#Fixed-6">Fixed</a><a class="docs-heading-anchor-permalink" href="#Fixed-6" title="Permalink"></a></h3><ul><li>Update generated <code>EditURL</code> 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. (<a href="https://github.com/fredrikekre/Literate.jl/issues/219">#219</a>)</li></ul><h2 id="[v2.14.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.0)-2022-09-22"><a class="docs-heading-anchor" href="#[v2.14.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.0)-2022-09-22"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.0">v2.14.0</a> - 2022-09-22</a><a id="[v2.14.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.0)-2022-09-22-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.14.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.14.0)-2022-09-22" title="Permalink"></a></h2><h3 id="Changed-4"><a class="docs-heading-anchor" href="#Changed-4">Changed</a><a class="docs-heading-anchor-permalink" href="#Changed-4" title="Permalink"></a></h3><ul><li>Image filenames resulting from executing markdown files (<code>Literate.markdown(...; execute=true)</code>) have changed from a number based on the hash of the source block to the format <code>{name}-{blocknumber}.(svg|png|...)</code>. (<a href="https://github.com/fredrikekre/Literate.jl/issues/204">#204</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/205">#205</a>)</li></ul><h2 id="[v2.13.4](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.4)-2022-06-03"><a class="docs-heading-anchor" href="#[v2.13.4](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.4)-2022-06-03"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.4">v2.13.4</a> - 2022-06-03</a><a id="[v2.13.4](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.4)-2022-06-03-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.13.4](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.4)-2022-06-03" title="Permalink"></a></h2><h3 id="Fixed-7"><a class="docs-heading-anchor" href="#Fixed-7">Fixed</a><a class="docs-heading-anchor-permalink" href="#Fixed-7" title="Permalink"></a></h3><ul><li>Automatic head branch detection (introduced in version 2.11.0) caused a performance regression since the <code>git remote show</code> 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. <a href="https://github.com/tlienart/LiveServer.jl">LiveServer.jl</a>. 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 <code>edit_commit</code> keyword argument. Doing so will now completely skip the slow <code>git</code> command. (<a href="https://github.com/fredrikekre/Literate.jl/commit/8054d26">8054d26</a>)</li></ul><h2 id="[v2.13.3](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.3)-2022-05-21"><a class="docs-heading-anchor" href="#[v2.13.3](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.3)-2022-05-21"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.3">v2.13.3</a> - 2022-05-21</a><a id="[v2.13.3](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.3)-2022-05-21-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.13.3](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.3)-2022-05-21" title="Permalink"></a></h2><h3 id="Fixed-8"><a class="docs-heading-anchor" href="#Fixed-8">Fixed</a><a class="docs-heading-anchor-permalink" href="#Fixed-8" title="Permalink"></a></h3><ul><li>Update remote HEAD branch detection to use <code>addenv</code> instead of <code>setenv</code> such that e.g. ssh-agent variables are available to the git command. Also set <code>GIT_SSH_COMMAND='ssh -o "BatchMode yes"'</code> to supress prompts when using ssh. (<a href="https://github.com/fredrikekre/Literate.jl/issues/197">#197</a>)</li></ul><h2 id="[v2.13.2](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.2)-2022-04-22"><a class="docs-heading-anchor" href="#[v2.13.2](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.2)-2022-04-22"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.2">v2.13.2</a> - 2022-04-22</a><a id="[v2.13.2](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.2)-2022-04-22-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.13.2](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.2)-2022-04-22" title="Permalink"></a></h2><h3 id="Fixed-9"><a class="docs-heading-anchor" href="#Fixed-9">Fixed</a><a class="docs-heading-anchor-permalink" href="#Fixed-9" title="Permalink"></a></h3><ul><li>Set current working directory for markdown execution to the output directory, just like notebook execution. (<a href="https://github.com/fredrikekre/Literate.jl/issues/195">#195</a>)</li><li>Set the apparent source file to the output file for markdown and notebook execution. (<a href="https://github.com/fredrikekre/Literate.jl/issues/195">#195</a>)</li></ul><h2 id="[v2.13.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.1)-2022-04-12"><a class="docs-heading-anchor" href="#[v2.13.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.1)-2022-04-12"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.1">v2.13.1</a> - 2022-04-12</a><a id="[v2.13.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.1)-2022-04-12-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.13.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.1)-2022-04-12" title="Permalink"></a></h2><h3 id="Fixed-10"><a class="docs-heading-anchor" href="#Fixed-10">Fixed</a><a class="docs-heading-anchor-permalink" href="#Fixed-10" title="Permalink"></a></h3><ul><li>Disable git terminal prompt when detecting remote HEAD branch. (<a href="https://github.com/fredrikekre/Literate.jl/issues/194">#194</a>)</li></ul><h2 id="[v2.13.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.0)-2022-02-18"><a class="docs-heading-anchor" href="#[v2.13.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.0)-2022-02-18"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.0">v2.13.0</a> - 2022-02-18</a><a id="[v2.13.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.0)-2022-02-18-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.13.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.13.0)-2022-02-18" title="Permalink"></a></h2><h3 id="Changed-5"><a class="docs-heading-anchor" href="#Changed-5">Changed</a><a class="docs-heading-anchor-permalink" href="#Changed-5" title="Permalink"></a></h3><ul><li>"Markdown stdlib-style" inline math (e.g. <code>``f(x) = x^2``</code>) is now replaced with "notebook style" math (<code>$f(x) = x^2$</code>) for notebook output. This is already the case for display math (<span>$```math$</span>). (<a href="https://github.com/fredrikekre/Literate.jl/issues/116">#116</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/190">#190</a>)</li></ul><h3 id="Fixed-11"><a class="docs-heading-anchor" href="#Fixed-11">Fixed</a><a class="docs-heading-anchor-permalink" href="#Fixed-11" title="Permalink"></a></h3><ul><li>Lines with trailing <code>#hide</code> are not shown in output of Markdown execution with Documenter flavor. (<a href="https://github.com/fredrikekre/Literate.jl/issues/166">#166</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/188">#188</a>)</li></ul><h2 id="[v2.12.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.12.1)-2022-02-10"><a class="docs-heading-anchor" href="#[v2.12.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.12.1)-2022-02-10"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.12.1">v2.12.1</a> - 2022-02-10</a><a id="[v2.12.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.12.1)-2022-02-10-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.12.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.12.1)-2022-02-10" title="Permalink"></a></h2><h3 id="Fixed-12"><a class="docs-heading-anchor" href="#Fixed-12">Fixed</a><a class="docs-heading-anchor-permalink" href="#Fixed-12" title="Permalink"></a></h3><ul><li>Make sure Markdown execution picks up new definitions of display methods (by running in the latest "world age"). (<a href="https://github.com/fredrikekre/Literate.jl/issues/187">#187</a>)</li></ul><h2 id="[v2.12.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.12.0)-2022-02-01"><a class="docs-heading-anchor" href="#[v2.12.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.12.0)-2022-02-01"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.12.0">v2.12.0</a> - 2022-02-01</a><a id="[v2.12.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.12.0)-2022-02-01-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.12.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.12.0)-2022-02-01" title="Permalink"></a></h2><h3 id="Changed-6"><a class="docs-heading-anchor" href="#Changed-6">Changed</a><a class="docs-heading-anchor-permalink" href="#Changed-6" title="Permalink"></a></h3><ul><li>User input configurations can now be <code>AbstractDict</code>s instead of just <code>Dict</code>s. (<a href="https://github.com/fredrikekre/Literate.jl/issues/185">#185</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/186">#186</a>)</li></ul><h2 id="[v2.11.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.11.0)-2022-01-25"><a class="docs-heading-anchor" href="#[v2.11.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.11.0)-2022-01-25"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.11.0">v2.11.0</a> - 2022-01-25</a><a id="[v2.11.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.11.0)-2022-01-25-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.11.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.11.0)-2022-01-25" title="Permalink"></a></h2><h3 id="Added-6"><a class="docs-heading-anchor" href="#Added-6">Added</a><a class="docs-heading-anchor-permalink" href="#Added-6" title="Permalink"></a></h3><ul><li>Literate now tries to figure out the branch/commit that <code>EditURL</code> should point to automatically instead of always defaulting to <code>"master"</code>. For typical setups the auto-detection should be sufficient, but you can also set it explicitly by passing <code>edit_commit</code>, for example <code>edit_commit = "main"</code>. (<a href="https://github.com/fredrikekre/Literate.jl/issues/179">#179</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/184">#184</a>)</li></ul><h2 id="[v2.10.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.10.0)-2022-01-24"><a class="docs-heading-anchor" href="#[v2.10.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.10.0)-2022-01-24"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.10.0">v2.10.0</a> - 2022-01-24</a><a id="[v2.10.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.10.0)-2022-01-24-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.10.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.10.0)-2022-01-24" title="Permalink"></a></h2><h3 id="Added-7"><a class="docs-heading-anchor" href="#Added-7">Added</a><a class="docs-heading-anchor-permalink" href="#Added-7" title="Permalink"></a></h3><ul><li>Markdown execution now also support <code>image/svg+xml</code>. (<a href="https://github.com/fredrikekre/Literate.jl/issues/182">#182</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/183">#183</a>)</li></ul><h2 id="[v2.9.4](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.4)-2021-10-18"><a class="docs-heading-anchor" href="#[v2.9.4](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.4)-2021-10-18"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.4">v2.9.4</a> - 2021-10-18</a><a id="[v2.9.4](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.4)-2021-10-18-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.9.4](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.4)-2021-10-18" title="Permalink"></a></h2><h3 id="Fixed-13"><a class="docs-heading-anchor" href="#Fixed-13">Fixed</a><a class="docs-heading-anchor-permalink" href="#Fixed-13" title="Permalink"></a></h3><ul><li>Fix multiline comment support for <code>\r\n</code> line endings. (<a href="https://github.com/fredrikekre/Literate.jl/issues/171">#171</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/172">#172</a>)</li></ul><h2 id="[v2.9.3](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.3)-2021-09-01"><a class="docs-heading-anchor" href="#[v2.9.3](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.3)-2021-09-01"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.3">v2.9.3</a> - 2021-09-01</a><a id="[v2.9.3](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.3)-2021-09-01-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.9.3](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.3)-2021-09-01" title="Permalink"></a></h2><h3 id="Fixed-14"><a class="docs-heading-anchor" href="#Fixed-14">Fixed</a><a class="docs-heading-anchor-permalink" href="#Fixed-14" title="Permalink"></a></h3><ul><li>Fix named <code>@examples</code> from <code>Literate.markdown</code> to not contain spaces even if the source filename does. (<a href="https://github.com/fredrikekre/Literate.jl/issues/168">#168</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/169">#169</a>)</li></ul><h2 id="[v2.9.2](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.2)-2021-08-16"><a class="docs-heading-anchor" href="#[v2.9.2](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.2)-2021-08-16"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.2">v2.9.2</a> - 2021-08-16</a><a id="[v2.9.2](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.2)-2021-08-16-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.9.2](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.2)-2021-08-16" title="Permalink"></a></h2><h3 id="Fixed-15"><a class="docs-heading-anchor" href="#Fixed-15">Fixed</a><a class="docs-heading-anchor-permalink" href="#Fixed-15" title="Permalink"></a></h3><ul><li>Fix multiline comment support for <code>\r\n</code> line endings. (<a href="https://github.com/fredrikekre/Literate.jl/issues/165">#165</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/167">#167</a>)</li></ul><h2 id="[v2.9.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.1)-2021-07-30"><a class="docs-heading-anchor" href="#[v2.9.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.1)-2021-07-30"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.1">v2.9.1</a> - 2021-07-30</a><a id="[v2.9.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.1)-2021-07-30-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.9.1](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.1)-2021-07-30" title="Permalink"></a></h2><h3 id="Fixed-16"><a class="docs-heading-anchor" href="#Fixed-16">Fixed</a><a class="docs-heading-anchor-permalink" href="#Fixed-16" title="Permalink"></a></h3><ul><li>Automatic URLs from <code>@__NBVIEWER_ROOT_URL__</code> and <code>@__BINDER_ROOT_URL__</code> now follow the convention <a href="https://github.com/JuliaDocs/Documenter.jl/pull/1298">used in Documenter.jl</a> to ignore build version information. (<a href="https://github.com/fredrikekre/Literate.jl/issues/162">#162</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/163">#163</a>)</li></ul><h2 id="[v2.9.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.0)-2021-07-09"><a class="docs-heading-anchor" href="#[v2.9.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.0)-2021-07-09"><a href="https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.0">v2.9.0</a> - 2021-07-09</a><a id="[v2.9.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.0)-2021-07-09-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.9.0](https://github.com/fredrikekre/Literate.jl/releases/tag/v2.9.0)-2021-07-09" title="Permalink"></a></h2><h3 id="Added-8"><a class="docs-heading-anchor" href="#Added-8">Added</a><a class="docs-heading-anchor-permalink" href="#Added-8" title="Permalink"></a></h3><ul><li>Added "Franklin flavored" markdown output for usage with [Franklin] (https://franklinjl.org/). Enable by passing the <code>flavor</code> keyword argument:<pre><code class="language-julia hljs">Literate.markdown(...; flavor = Literate.FranklinFlavor())</code></pre>(<a href="https://github.com/fredrikekre/Literate.jl/issues/146">#146</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/147">#147</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/156">#156</a>)</li><li>Added "Documenter flavored" markdown output as a replacement for <code>documenter=true</code>, and "CommonMark flavored" markdown output as a replacement for <code>documenter=false</code>. Enable by passing the <code>flavor</code> keyword argument:<pre><code class="language-julia hljs">Literate.markdown(...; flavor = Literate.DocumenterFlavor()) |
|
|
Literate.markdown(...; flavor = Literate.CommonMarkFlavor())</code></pre>(<a href="https://github.com/fredrikekre/Literate.jl/issues/159">#159</a>)</li><li>Added option to use multiline markdown strings (<code>md""" ... """</code>) as markdown sections. To enable, pass <code>mdstrings=true</code>. (<a href="https://github.com/fredrikekre/Literate.jl/issues/152">#152</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/149">#149</a>)</li></ul><h3 id="Changed-7"><a class="docs-heading-anchor" href="#Changed-7">Changed</a><a class="docs-heading-anchor-permalink" href="#Changed-7" title="Permalink"></a></h3><ul><li>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 <code>Cmd</code>. (<a href="https://github.com/fredrikekre/Literate.jl/issues/144">#144</a>, <a href="https://github.com/fredrikekre/Literate.jl/issues/145">#145</a>)</li><li>Replacement of Documenter-style <code>@ref</code> and <code>@id</code> elements are now removed unconditionally instead of conditionally based on the (now deprecated) <code>documenter</code> keyword argument. (<a href="https://github.com/fredrikekre/Literate.jl/issues/159">#159</a>)</li></ul><h3 id="Deprecated"><a class="docs-heading-anchor" href="#Deprecated">Deprecated</a><a id="Deprecated-1"></a><a class="docs-heading-anchor-permalink" href="#Deprecated" title="Permalink"></a></h3><ul><li>The <code>documenter</code> keyword argument has been deprecated. For <code>Literate.markdown</code> the the replacement is to use <code>flavor = Literate.DocumenterFlavor()</code> or <code>flavor = Literate.CommonMarkFlavor()</code> as appropriate (see above). For <code>Literate.notebook</code> and <code>Literate.script</code> the option is now unused (see above regarding <code>@ref</code> and <code>@id</code>), and no replacement is necessary. (<a href="https://github.com/fredrikekre/Literate.jl/issues/159">#159</a>)</li></ul><h2 id="v2.8-2021-01-19"><a class="docs-heading-anchor" href="#v2.8-2021-01-19">v2.8 - 2021-01-19</a><a id="v2.8-2021-01-19-1"></a><a class="docs-heading-anchor-permalink" href="#v2.8-2021-01-19" title="Permalink"></a></h2><h3 id="Added-9"><a class="docs-heading-anchor" href="#Added-9">Added</a><a class="docs-heading-anchor-permalink" href="#Added-9" title="Permalink"></a></h3><ul><li>Execution of notebooks now capture output of <code>display(x)</code> and <code>display(mime, x)</code> (<a href="https://github.com/fredrikekre/Literate.jl/commit/ceff7a3">ceff7a3</a>).</li></ul><h2 id="v2.7-2021-09-12"><a class="docs-heading-anchor" href="#v2.7-2021-09-12">v2.7 - 2021-09-12</a><a id="v2.7-2021-09-12-1"></a><a class="docs-heading-anchor-permalink" href="#v2.7-2021-09-12" title="Permalink"></a></h2><h3 id="Added-10"><a class="docs-heading-anchor" href="#Added-10">Added</a><a class="docs-heading-anchor-permalink" href="#Added-10" title="Permalink"></a></h3><ul><li>Multiline-style Julia comments (<code>#= ... =#</code>) can now be used for markdown input (<a href="https://github.com/fredrikekre/Literate.jl/commit/dc409d0">dc409d0</a>).</li></ul><h2 id="v2.6-2020-08-15"><a class="docs-heading-anchor" href="#v2.6-2020-08-15">v2.6 - 2020-08-15</a><a id="v2.6-2020-08-15-1"></a><a class="docs-heading-anchor-permalink" href="#v2.6-2020-08-15" title="Permalink"></a></h2><h3 id="Added-11"><a class="docs-heading-anchor" href="#Added-11">Added</a><a class="docs-heading-anchor-permalink" href="#Added-11" title="Permalink"></a></h3><ul><li>New end-of-line token <code>#hide</code> which filters out the line <em>after</em> execution in <code>Literate.markdown(...; execute=true)</code> (<a href="https://github.com/fredrikekre/Literate.jl/commit/6d1aec9">6d1aec9</a>).</li><li>Markdown execution now captures the <code>text/markdown</code> MIME (<a href="https://github.com/fredrikekre/Literate.jl/commit/e08ca0a">e08ca0a</a>).</li></ul><h2 id="v2.5-2020-05-14"><a class="docs-heading-anchor" href="#v2.5-2020-05-14">v2.5 - 2020-05-14</a><a id="v2.5-2020-05-14-1"></a><a class="docs-heading-anchor-permalink" href="#v2.5-2020-05-14" title="Permalink"></a></h2><h3 id="Changed-8"><a class="docs-heading-anchor" href="#Changed-8">Changed</a><a class="docs-heading-anchor-permalink" href="#Changed-8" title="Permalink"></a></h3><ul><li>The output directory now defaults to <code>pwd()</code> (<a href="https://github.com/fredrikekre/Literate.jl/commit/2ba316a">2ba316a</a>).</li></ul><h2 id="v2.4-2020-04-23"><a class="docs-heading-anchor" href="#v2.4-2020-04-23">v2.4 - 2020-04-23</a><a id="v2.4-2020-04-23-1"></a><a class="docs-heading-anchor-permalink" href="#v2.4-2020-04-23" title="Permalink"></a></h2><h3 id="Added-12"><a class="docs-heading-anchor" href="#Added-12">Added</a><a class="docs-heading-anchor-permalink" href="#Added-12" title="Permalink"></a></h3><ul><li>Markdown output can now be executed and the result included in the output by pasing <code>execute=true</code> to <code>Literate.markdown</code>. Currently captures the following MIMEs: <code>text/plain</code>, <code>image/png</code>, and <code>image/jpeg</code> (<a href="https://github.com/fredrikekre/Literate.jl/commit/7e89fdb">7e89fdb</a>).</li></ul><h2 id="v2.3-2020-03-03"><a class="docs-heading-anchor" href="#v2.3-2020-03-03">v2.3 - 2020-03-03</a><a id="v2.3-2020-03-03-1"></a><a class="docs-heading-anchor-permalink" href="#v2.3-2020-03-03" title="Permalink"></a></h2><h3 id="Added-13"><a class="docs-heading-anchor" href="#Added-13">Added</a><a class="docs-heading-anchor-permalink" href="#Added-13" title="Permalink"></a></h3><ul><li>Filter tokens <code>#md</code>, <code>#nb</code>, and <code>#jl</code>, as well as their negated counterparts, can now be placed at the end of lines (<a href="https://github.com/fredrikekre/Literate.jl/commit/b0806ed">b0806ed</a>).</li></ul><h2 id="v2.2-2019-11-26"><a class="docs-heading-anchor" href="#v2.2-2019-11-26">v2.2 - 2019-11-26</a><a id="v2.2-2019-11-26-1"></a><a class="docs-heading-anchor-permalink" href="#v2.2-2019-11-26" title="Permalink"></a></h2><h3 id="Added-14"><a class="docs-heading-anchor" href="#Added-14">Added</a><a class="docs-heading-anchor-permalink" href="#Added-14" title="Permalink"></a></h3><ul><li>Configuration can now be passed as a <code>config::Dict</code> keyword argument to the generators (<a href="https://github.com/fredrikekre/Literate.jl/commit/0f9e836">0f9e836</a>).</li><li>Link macros now works when running on GitLab CI (<a href="https://github.com/fredrikekre/Literate.jl/commit/4e71b15">4e71b15</a>).</li><li>Literate now supports more configuration for e.g. URL's that <code>@__REPO_ROOT_URL__</code> and friends expand to (<a href="https://github.com/fredrikekre/Literate.jl/commit/4e71b15">4e71b15</a>).</li></ul><h2 id="v2.1-2019-10-30"><a class="docs-heading-anchor" href="#v2.1-2019-10-30">v2.1 - 2019-10-30</a><a id="v2.1-2019-10-30-1"></a><a class="docs-heading-anchor-permalink" href="#v2.1-2019-10-30" title="Permalink"></a></h2><h3 id="Added-15"><a class="docs-heading-anchor" href="#Added-15">Added</a><a class="docs-heading-anchor-permalink" href="#Added-15" title="Permalink"></a></h3><ul><li>Link macros now works when running on GitHub Actions (<a href="https://github.com/fredrikekre/Literate.jl/commit/cf2b552">cf2b552</a>).</li></ul><h2 id="v2.0-2019-07-19"><a class="docs-heading-anchor" href="#v2.0-2019-07-19">v2.0 - 2019-07-19</a><a id="v2.0-2019-07-19-1"></a><a class="docs-heading-anchor-permalink" href="#v2.0-2019-07-19" title="Permalink"></a></h2><h3 id="Added-16"><a class="docs-heading-anchor" href="#Added-16">Added</a><a class="docs-heading-anchor-permalink" href="#Added-16" title="Permalink"></a></h3><ul><li>Negated filter tokens (<code>#!nb</code>, <code>#!md</code> and <code>#!jl</code>) are now supported (<a href="https://github.com/fredrikekre/Literate.jl/commit/1d02868">1d02868</a>).</li><li>Notebook output now support cell metadata with the <code>%%</code>-format (<a href="https://github.com/fredrikekre/Literate.jl/commit/0872a96">0872a96</a>).</li></ul><h3 id="Changed-9"><a class="docs-heading-anchor" href="#Changed-9">Changed</a><a class="docs-heading-anchor-permalink" href="#Changed-9" title="Permalink"></a></h3><ul><li><strong>BREAKING</strong> The link macros <code>@__REPO_ROOT_URL__</code>, <code>@__NBVIEWER_ROOT_URL__</code> and <code>@__BINDER_ROOT_URL__</code> no longer include a trailing <code>/</code> (<a href="https://github.com/fredrikekre/Literate.jl/commit/7af5414">7af5414</a>).</li><li><strong>BREAKING</strong> The (undocumented) feature of Documenter continued blocks now requires an explicit <code>#+</code> chunk splitter (<a href="https://github.com/fredrikekre/Literate.jl/commit/36e8c21">36e8c21</a>).</li><li>The link macros <code>@__REPO_ROOT_URL__</code>, <code>@__NBVIEWER_ROOT_URL__</code> now expands to correct paths when documentation is built with DocumentationGenerator.jl (<a href="https://github.com/fredrikekre/Literate.jl/commit/7af5414">7af5414</a>).</li></ul><h2 id="v1.1-2019-04-05"><a class="docs-heading-anchor" href="#v1.1-2019-04-05">v1.1 - 2019-04-05</a><a id="v1.1-2019-04-05-1"></a><a class="docs-heading-anchor-permalink" href="#v1.1-2019-04-05" title="Permalink"></a></h2><h3 id="Added-17"><a class="docs-heading-anchor" href="#Added-17">Added</a><a class="docs-heading-anchor-permalink" href="#Added-17" title="Permalink"></a></h3><ul><li>New link macro <code>@__BINDER_ROOT_URL__</code> for linking to notebooks mybinder.org (<a href="https://github.com/fredrikekre/Literate.jl/commit/fa64dcd">fa64dcd</a>).</li></ul><h2 id="v1.0-2019-03-06"><a class="docs-heading-anchor" href="#v1.0-2019-03-06">v1.0 - 2019-03-06</a><a id="v1.0-2019-03-06-1"></a><a class="docs-heading-anchor-permalink" href="#v1.0-2019-03-06" title="Permalink"></a></h2><p>First stable release of Literate.jl, see https://discourse.julialang.org/t/ann-literate-jl/10651 for release announcement.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../generated/example/">« <strong>8.</strong> Example</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.16.0 on <span class="colophon-date" title="Tuesday 2 December 2025 15:39">Tuesday 2 December 2025</span>. Using Julia version 1.12.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
|
|
|
|