summaryrefslogtreecommitdiff
path: root/macros/generic/markdown/CHANGES.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/generic/markdown/CHANGES.md')
-rw-r--r--macros/generic/markdown/CHANGES.md104
1 files changed, 104 insertions, 0 deletions
diff --git a/macros/generic/markdown/CHANGES.md b/macros/generic/markdown/CHANGES.md
index 922aadff91..1b32517f09 100644
--- a/macros/generic/markdown/CHANGES.md
+++ b/macros/generic/markdown/CHANGES.md
@@ -1,5 +1,109 @@
# Changes
+## 3.7.1 (2024-09-30)
+
+Development:
+
+- Remove dependency on `UnicodeData.txt`. (#400, #458 #486, #492, #499)
+
+ This change improves the speed of parsing markdown input by up to 25%
+ for a cold conversion run and makes life easier for users of TeX
+ distributions other than TeX Live, such as MikTeX and ConTeXt Standalone,
+ where `UnicodeData.txt` may not be as easily available. This change also
+ adds a new file `markdown-unicode-data.lua`, which must be properly
+ installed with the rest of the Markdown package.
+
+- Add renderers `warning` and `error` that represent warnings and errors
+ produced by the markdown parser. (#452, #473, #496)
+
+Fixes:
+
+- Properly load LaTeX themes when `theme` or `import` is used in
+ `\usepackage[...]{markdown}`. (#471, #498)
+
+- Prevent endless loop when setting deprecated `jekyllDataString` (renderer)
+ prototype. (#500)
+
+- Correctly handle backslashes in `\markdownOptionOutputDir` on Windows.
+ (#492, #500, reported by @l0th3r)
+
+- Fix hard line breaks in blockquotes.
+ (#494, #495, reported by @l0th3r, #496, contributed by @lostenderman)
+
+Deprecation:
+
+- Soft-deprecate the `hybrid` option. (#470, #504, 546faa87)
+
+ Soft-deprecated features will never be removed but using them prints a
+ warning and is discouraged. Instead of the `hybrid` option, consider one of
+ the following better alternatives for mixing TeX and markdown:
+
+ - With the `contentBlocks` option, authors can move large blocks of TeX
+ code to separate files and include them in their markdown documents as
+ external resources.
+
+ - With the `rawAttribute` option, authors can denote raw text spans and
+ code blocks that will be interpreted as TeX code.
+
+ - With options `texMathDollars`, `texMathSingleBackslash`, and
+ `texMathDoubleBackslash`, authors can freely type TeX commands between
+ dollar signs or backslash-escaped brackets.
+
+ For more information, see the user manual at
+ <https://witiko.github.io/markdown/>.
+
+## 3.7.0 (2024-08-30)
+
+Development:
+
+- Add renderer `jekyllDataProgrammaticString` for processing YAML
+ string scalars that do not contain markdown markup and are not
+ intended for typesetting.
+ (istqborg/istqb_product_base#46, #440, #451, sponsored by @istqborg)
+- Add option `ensureJekyllData` for processing standalone YAML files.
+ (#452, #473, sponsored by @istqborg)
+- Support user-defined LaTeX environments with LaTeX markup.
+ (#20, #477, suggested by @cdupont)
+
+Fixes:
+
+- Produce more meaningful error message when KPathSea fails to
+ locate a file. (#458, #472, 33e6eef2, reported by @Yggdrasil128)
+- Fix soft line breaks in citation prenotes and postnotes.
+ (#483, #484, contributed by @lostenderman)
+
+Speed improvements:
+
+- Precompile snippets to improve the speed of setting them.
+ (#467, #479, inspired by the TUG 2024 talk by @josephwright)
+- Use an optimized parser to determine Unicode punctuation.
+ (#458, #474, #482, 4c1a7de2, co-authored by @Yggdrasil128,
+ sponsored by @istqborg)
+ This improves the speed of parsing markdown input by up to 500%.
+- Enable option `eagerCache` by default. (#468, #490, sponsored by @istqborg)
+ This improves the speed by up to 25% for large documents with many
+ markdown fragments that require multiple compilation runs.
+- Prevent loading the full Markdown package when converting cached markdown
+ fragments. (#487, #491, 40f0803f, 6609d43d, sponsored by @istqborg)
+ This significantly improves the speed for large documents with many
+ markdown fragments that require multiple compilation runs in pdfTeX.
+
+Deprecation:
+
+- Deprecate `jekyllDataString` renderer and renderer prototype.
+ (istqborg/istqb_product_base#46, #440, #451, sponsored by @istqborg)
+ Users should use `jekyllDataTypographicString` instead.
+
+Continuous Integration:
+
+- Ensure that all code lines are shorter than 72 characters.
+ (#478, e7160d60, 3ac95efe)
+
+Experiments:
+
+- Measure the speed of the Markdown package across recent versions.
+ (249552e5, 55ede824, efeaecbe, #474, 7b2b2431, fcf0064c)
+
## 3.6.2 (2024-07-14)
Fixes: