Change Log

All notable changes to the PreTeXt-CLI will be documented in this file (admittedly started rather late in the game).

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

Instructions: Add a subsection under [Unreleased] for additions, fixes, changes, and removals of features accompanying each PR. When a release is made, the github action will automatically add the next version number above the unreleased changes with the date of release.

[Unreleased]

[2.38.3] - 2026-04-21

Includes updates to core through commit: f22ebc5

Added

Better support for building latex from pretext: detects when latex needs to be rerun multiple times.

Fixed

Bug that failed to detect webwork problems authored as local pg files.
epub fillinmath and sfrac rendering.

[2.38.2] - 2026-04-07

Includes updates to core through commit: 22c2cd3

Fixed

Fix for fill-ins for Runestone builds
Annotated prefigure diagrams in printouts now correctly hide instructions.

[2.38.1] - 2026-04-04

Includes updates to core through commit: 80f77ab

Added

Backlinks on solutions and hints to their corresponding tasks in the main text.

Changed

LaTeX special characters with MathJax using the textmacros extension.

[2.38.0] - 2026-04-01

Includes updates to core through commit: 8fa4391

Added

Support for "paragraphs" element in printouts (worksheets and handouts).
Optional LaTeX link highlighting via the latex/@link-highlight publisher option.
New quotation mark styles for Canada and Germany locales.

Fixed

Failed individual asset generation (when core does not produce the expected output file) now raises an error and is no longer silently treated as a success. This prevents incorrectly caching incomplete asset generation results.
Landing page links for print and single-file targets now generate correctly.
JavaScript bug in printouts that miscalculated workspace with slow-loading images.

Changed

The default Asymptote generation method is now local (using the local asy binary) instead of server. This improves reliability since the server method has been subject to breakage whenever the Asymptote web interface is updated. Users who need the server method can still opt in via asy-method="server" in project.ptx.

[2.37.1] - 2026-02-19

Includes updates to core through commit: 4e4ff13

Added

Design-width publication variable for interactives for improved sizing.
Improvements to sidebyside images in slideshows.

Fixed

Improvements to printouts: hide image descriptions and order tasks correctly.
Bug that incorrectly clipped prefigure images for portable builds

[2.36.0] - 2026-01-14

Includes updates to core through commit: 3b7177a

Added

Support for headers and footers in worksheets and handouts.
Improved punctuation for LaTeX "cases" environment.

[2.35.0] - 2026-01-08

Includes updates to core through commit: d95a31b

Added

Publisher controlled page breaks for PDF output

Changes

Simplified course template

[2.34.0] - 2026-01-02

Includes updates to core through commit: a7a0894

Added

Better support for portable builds that use worksheets and handouts (they print now).
Improved print controls: show/hide hints/answers/solutions in print view.
Improved whitespace in program elements.
Support shortdescription and description for interactive elements.

[2.33.2] - 2025-12-13

Includes updates to core through commit: 1c97959

Changed

Simplify course template.
Update requirements for lxml to version 6 for compatibility with python 3.14 on Windows.

[2.33.1] - 2025-12-11

Includes updates to core through commit: 1c97959

Changed

Improved course template and updated readme's for main templates.

[2.33.0] - 2025-12-06

Includes updates to core through commit: 1c97959

Added

The latex-source attribute, set to anything except "no", on a target with format pdf will copy latex source files to output directory.
Improvements to ePub output format (core).
Experimental dual static/interactive exercises with Runestone support (core).
Improvements to intertext in display math (core).

[2.32.0] - 2025-11-23

Includes updates to core through commit: ce20f15

Added

PDF targets built with --latex flag will include the latex source in the output directory.

[2.31.0] - 2025-11-20

Includes updates to core through commit: 65231d1

Added

Support for Kotlin programming language in activecode. (core)
Improvements for Mermaid image generation. (core)
Image descriptions now work on Asymptote images. (core)

Changed

Display math can be placed inside <md> (without <mrow>) instead of <me>. Numbered equations now specified with an attribute. (core)

Fixed

Bug that sometimes prevented pretext view from working due to permissions on mac.
Typos in template publication files.
Default output filename for the slideshow template is now index.html so pretext view will open directly to the slideshow.
Bug that sometimes prevented a journal article style file from being downloaded.

[2.30.2] - 2025-11-11

Includes updates to core through commit: ad3ef3f

Changed

Runestone builds no longer try to generate codechat mapping (if you want to use codechat previews, use a non-runestone html build).

[2.30.1] - 2025-11-10

Includes updates to core through commit: e406b5c

Fixed

Bug preventing OPL WeBWorK problems from loading inside Runestone.

[2.30.0] - 2025-11-06

Includes updates to core through commit: 6e68559

Added

New --slow option for pretext generate to increase the timeout for interactive preview generation.
Publisher options for hiding subtitle and byline in html page banner.
Solution-like elements persist for Runestone assignment page.
worksheet added to stable schema; handout added to dev schema.

Changed

When an update is available, report this on every run of pretext.
md elements with no mrow produce math equations (previously me).

Fixed

Styling for non-math, non-interactive fillins in html.
MathJax svg display in dark mode.
Table justification in html.

[2.29.2] - 2025-09-10

Includes updates to core through commit: 016b805

Fixed

Bug which prevented two projects to be previewed at the same time on Windows.
Better styling for html worksheets and handouts.
Better spacing around paragraphs inside other containers.

[2.29.1] - 2025-08-30

Includes updates to core through commit: f076608

Changed

Now checking for full list of deprecations from core pretext by default.

Fixed

Bug preventing locally authored WeBWorK from activating in Runestone.

[2.29.0] - 2025-08-26

Includes updates to core through commit: 38f9e6c

Added

A description list (dl) can now be set to @width="wide" to give more room for the titles/terms.

Changed

You can override the default table of contents "focus" (expandable levels) for a theme with a publication variable.

Fixed

Include introductions and conclusions for tasks in Runestone.
Variety of styling improvements.
dl with @width="narrow" now respected in HTML.
detached proofs now reference their theorem with a knowl and without duplication.
Project-like duplication for ActiveCode and CodeLens now fixed for Runestoone.

[2.28.2] - 2025-08-18

Includes updates to core through commit: 488b019

Fixed

Project-like that are inside a worksheet were not getting solutions in the backmatter.
Added an optional cname attribute on the <project> in the manifest to allow deploy to work with github pages using custom subdomains.

[2.28.1] - 2025-08-18

Includes updates to core through commit: 5fd31db

Fixed

Bug causing poor math output inside a sidebyside/stack.

[2.28.0] - 2025-08-16

Includes updates to core through commit: bec45fb

Added

New "handout" division, similar to worksheets, but intended for pages you print without exercises.
@workspace can go on most paragraph-level elements in worksheets and handouts.
Experimental support for improve bibliographies using citeproc. pretext generate references will generate the required xml file in generated assets.
Experimental support for generating STACK static assets. pretext generate stack will generate the required assets.

Fixed

Footnotes inside detached proof works better in print conversion.
Improve autoscroll of table of contents for HTML.

[2.27.0] - 2025-08-12

Includes updates to core through commit: 132ca23

Changed

Legacy themes for HTML will now be automatically replaced with their new equivalents.

Added

Codelense trace improvements.

Fixed

Bug preventing authored webwork problems in projects from being generated.
Runestone profile menu now works in mobile view.

[2.26.0] - 2025-08-11

Includes updates to core through commit: 8b25e5f

Changed

HTML links no longer produce footnotes with url; LaTeX puts url in parentheses (core).

Added

WeBWorK problems can be authored in bare PG (core).

Fixed

Bug preventing braille building to work.
Bug preventing workspace in HTML worksheets when no special worksheet formatting is requested (core).
Variety of HTML theme improvements (core).

[2.25.1] - 2025-08-01

Includes updates to core through commit: f15f9b9

Fixed

Bug in which qrcodes don't generate for video/audio if no interactive or youtube elements exist.

Changed

qrcodes for pdf are now generated based on a hash of the elements they point to in addition to the baseurl for the publication file.

[2.25.0] - 2025-07-26

Includes updates to core through commit: 45be2cf

Changed

NEW BEHAVIOR: the pretext build -g command will not use cached versions of assets when regenerating. You can still generate assets and use the cache with pretext generate.
Improve default settings in codespace settings.

[2.24.0] - 2025-07-21

Includes updates to core through commit: 32262dd

Changed

Template devcontainer will now use versioned docker image.
The pretext upgrade command will include prefigure and pelican if they are already installed.

Fixed

Bug that sometimes stopped pretext view from working in a codespace.

[2.23.1] - 2025-07-14

Includes updates to core through commit: c750a05

Fixed

Better error messages when node version is too low for FITB generation step.
Github actions now install the correct version of node for FITB generation step.
Worksheet printing bug cause by top page margin has been fixed.

Changed

Better messages when build/generate completes with errors.

[2.23.0] - 2025-07-11

Includes updates to core through commit: 899648f

Added

Print preview for worksheets now has option to highlight workspace and compare the rendered workspace to the authored height.
WeBWorK exercises can be generated using a local copy of PG (with the proper setup).

Changed

Generating dynamic substitutions now uses node instead of playwright. Node 22.10 or greater is required.

[2.22.0] - 2025-07-05

Includes updates to core through commit: e6f9288

Changed

Printing worksheets from HTML should work a lot better now. The "Print preview" page now matches the printed output, and you can toggle between letter and a4. Worksheets can be authored with or without <page> elements and still get good results.

Fixed

Publication file in templates had incorrect element for latex cover setting.

[2.21.0] - 2025-06-27

Includes updates to core through commit: 2bcef90

Changed

Python version 3.10 or higher is now required (removed support for python 3.8 and 3.9).

Fixed

Bug that caused MyOpenMath problems to be downloaded on every build, regardless of whether they were needed.
Bug which caused error in pretext view when the running_servers file contained a blank line.

[2.20.0] - 2025-06-20

Includes updates to core through commit: 1ef97c0

Changed

Default devcontainer setup now uses a simplified, versioned pretext-full docker image.

Fixed

Fill-in-the-blank questions do not need dynamic-subs assets for HTML-format builds; now they will no longer be generated.
Sometimes the pretext view command did not work in Codespaces. Now inactive server instances are removed immediately which should fix this issue.

Added

Sometimes something goes wrong with the pretext resources in ~/.ptx. You can now run pretext init --system to reinstall these resources for the current version. This will also try to run npm install for the css themes.

[2.19.3] - 2025-06-14

Includes updates to core through commit: 1b65b63

[2.19.2] - 2025-06-04

Includes updates to core through commit: b31d10b

[2.19.1] - 2025-05-24

Includes updates to core through commit: 6a4f8ff

[2.19.0] - 2025-05-23

Includes updates to core through commit: 2a9f32a

Added

You can now build standalone targets as PDF, HTML, or a SCORM archive using pretext build html -i path/to/ptx/file. Output will be placed adjacent to source.
You can now build standalone targets from within a project (in case you want to build arbitrary files without creating targets for them). Just add a target with standalone="yes" in the manifest.

[2.18.3] - 2025-05-19

Includes updates to core through commit: 638c52a

Changed

Update course template.

[2.18.2] - 2025-05-16

Includes updates to core through commit: 11011fb

Changed

Update devcontainer for codespaces with more custom settings and suggested extensions.

[2.18.1] - 2025-05-13

Includes updates to core through commit: 9be1596

[2.18.0] - 2025-05-06

Includes updates to core through commit: 1024036

Added

Support for more journals.
HTML build can now create a SCORM archive for uploading to an LMS.
Further improvements for portable html builds (fewer auxilary files created).
New "boulder" theme for minimal single-page HTML builds.
Optional embed button (for getting <iframe> code to put in an LMS).
Improvements to program element.

Changed

Improvements to wide elements in CSS themes
Deprecated "matches" in exercises in favor of "cardsort"
Listings now use titles instead of captions

[2.17.1] - 2025-04-10

Includes updates to core through commit: 7936f3f

Fixed

Bug preventing some repositories from using pretext deploy.

[2.17.0] - 2025-04-09

Includes updates to core through commit: 2c3fda7

Changed

The CLI now uses your assembled source in case you use "versions" for checking for some source errors and deciding whether assets must be regenerated. For example, if you change an asset in a component that is not part of a version, it will not trigger rebuilding all assets.

Fixed

Fixed a bug with the denver theme that displayed some tasks with their headings not inline.

[2.16.1] - 2025-04-08

Includes updates to core through commit: 7017d8f

[2.16.0] - 2025-04-07

Includes updates to core through commit: 7017d8f

Addded

New option for pretext deploy. If you pass --no-push then deploy will commit your output to the gh-pages branch but not push. This can be useful for CI/CD workflows or in case deploy encounters an authentication error.

Changed

The default devcontainer no longer includes a full LaTeX install. If you run into trouble generating latex-images or building pdfs, see the README.md file for assistance.
The default devcontainer no longer includes sagemath. If you want to build sageplot assets, see the README.md file for assistance.

[2.15.2] - 2025-03-31

Includes updates to core through commit: 7017d8f

Fixed

Bug preventing github actions from completing deploy (internal).

[2.15.1] - 2025-03-24

Includes updates to core through commit: 7017d8f

Added

Portable html builds now embed SVGs directly into the html (so you no longer need to upload them separately).
Coloraide package added as a dependency (for building custom themes).

[2.15.0] - 2025-03-15

Includes updates to core through commit: bd0998c

Added

Portable html: setting /publication/html/platform/@portable="yes" will create html output that doesn't rely on local css or js. Useful when chunking level is set to 0 to get a single html file to upload to an LMS.
Improved support for journals in the latex conversion.

Fixed

Dynamic substitution xml file was not generated on html build correctly; it is now.
Bug where permalinks sometimes fail to be added if there is a webwork problem on the page.
Miscellaneous HTML theme improvements.

Changed

Improved success feedback message.

[2.14.0] - 2025-02-26

Includes updates to core through commit: 8f8858c