mdcat

Changed

• Release builds no longer use fat LTO, which significantly reduces compilation time.
• Update dependencies.

Fixed

• mdcat no longer panics on markups in descriptions of rendered images (see GH-287).

Added

• mdcat now includes a --completions argument to generate shell completions for all major shells (see GH-286).

Changed

• Update dependencies.

Removed

• mdcat now longer builds shell completions and man pages during compilation (see GH-286).
  • Packagers now need to build the manpage explicitly during packaging.
• Release artifacts no longer contain completions; use mdcat --completions to generate them instead (see GH-286).

Fixed

• Restore binary release artifacts (see GH-284)

Changed

• Update dependencies to address Rust security advisories.

Changed

• Update all dependencies (see GH-274).

Added

• Support images in VSCode integrated terminal, 1.80 or newer (see GH-266).

Changed

• When rendering iTerm2 images append .png to the file name reported to the terminal if mdcat rendered an SVG to PNG (see GH-267).
  Previously, mdcat retained the original file extension, and would ask iTerm2 to download a PNG image to an .svg file.

Fixed

• Correct some iTerm2 inline image commands to better comply to the specification (see GH-267).
• Always terminate OSC commands with ST instead of BEL, as the latter is the legacy form (see GH-267).

Changed

• Update all dependencies.
• Bump MSRV to 1.72.

Changed

• mdcat now uses the kitty protocol to render images on WezTerm (see GH-258).
• mdcat now downscales images to the column limit if rendering with the kitty protocol (see GH-258).
  Previously mdcat scaled down to the window size, which looked strange if a given --columns was much smaller than the window size.

Changed

• Update dependencies.

Fixed

• Fix SVG rendering:
  • Correctly enable SVG rendering and image processing features by default in mdcat (see GH-256).
  • Ignore charset and other mime type parameters when checking for image/svg+xml (see GH-256).

Fixed

• Properly reset line wrapping state in list items (see GH-254).
• Flush trailing spaces before starting a link to avoid link styling over an initial whitespace (see GH-255).

Added

• mdcat now fills paragraph text to the column limit, i.e. fills up short lines and wraps long lines (see GH-4).
• mdcat now allows to control color and style via a new theme field in pulldown_cmark_mdcat::Settings of type pulldown_cmark_mdcat::Theme (see GH-48).
  pulldown_cmark_mdcat::Theme::default() provides the standard mdcat 1.x colors and style.
• mdcat now exposes resource handling via the new pulldown_cmark_mdcat::resources::ResourceUrlHandler trait (see GH-247).
• pulldown_cmark_mdcat allows to disable SVG support and thus avoid the resvg dependency by disabling the svg feature (see GH-249).
• pulldown_cmark_mdcat allows to disable image processing support and thus avoid the image dependency by disabling the image-processing feature (see GH-250).

Changed

• Update all dependencies.
• mdcat::Settings now holds a reference to a syntax set, so the syntax set can now be shared among multiple different settings.
• Explicitly set minimum rust version in Cargo.toml, and document MSRV policy.
• Move all core rendering functions into a new crate pulldown-cmark-mdcat; mdcat itself only contains the argument parsing and handling now (see GH-248).
  If you were using mdcat as a library before, you likely want to use pulldown-cmark-mdcat now.
• Move HTTP resource handling into new crate mdcat-http-reqwest, in order to isolate the rather heavy reqwest dependency (see GH-248).
• Increase timeouts for HTTP resources to avoid aborting too early.

Removed

• mdcat::Settings.resource_access and the corresponding ResourceAccess enum (see GH-247).

Fixed

• No longer elide tracing info below warn level in release builds (see GH-242)..
  This allows downstream consumers to keep tracing info included in their release builds.

Changed

• Update all dependencies.
  This removes a transitive dependency on a vulnerable version of remove_dir_all, see GHSA-mc8h-8q98-g5hr.
• No longer sniff mime type from contents to identify SVG images.
  Instead rely on the Content-Type header for HTTP(S) images and the file extension for local resources (see GH-239).
• Render SVG images using the pure Rust resvg crate instead of rsvg-convert; mdcat no longer requires the latter tool at runtime (see GH-240).

Fixed

• Use less -r instead of less -R in mdless if both $PAGER and $MDCAT_PAGER are unset (see GH-238).
• Time out external resources if no data was read for 100ms. Previously mdcat waited for 1s before timing out (see GH-241).

Added

• Add --detect-terminal to print the name of the detected terminal program (see GH-232).
• Add --ansi to skip terminal detection and use ANSI-formatting only (see GH-232).

Changed

• Replace ureq with reqwest (see GH-229).
  This implies that the default build now creates a binary linked against the system standard SSL library, i.e. openssl under Linux.
  A fully static build now requires --no-default-features --features static for cargo build.
• Terminal detection always checks $TERM first and trusts its value if it denotes a specific terminal emulator (see GH-232).
• Update all dependencies.

Fixed

• Correctly detect kitty started from iTerm (see GH-230 and GH-232).

Fixed

• Fix release workflow to restore release artifacts (see GH-218).

Fixed

• Fix workflow syntax error to restore release artifacts.

Changed

• Move repository back to https://github.com/lunaryorn/mdcat.
• Restore release binaries.
• Update dependencies, in particular clap to 4.0.15.

Removed

• Support for tree_magic_mini for mime-type detection; mdcat now only uses the file tool (see GH-204).

Changed

• Update all dependencies, in particular syntect to 5.0.0 and pulldown-cmark to 0.9.2.

Fixed

• Build error on Windows (see #201).

Added

• Add extensive tracing output, to aid debugging (see #147).

Changed

• mdcat no longer invokes file to detect SVG images, but now requires the presence of a system-wide magic database (see #154).
  Disable default features to restore the previous behaviour to invoke file to detect mimetypes.

Fixed

• File completion with zsh (see #198).

Changed

• Always output links as OSC-8 hyperlinks unless --dump is given.
  In particular, mdcat now prints hyperlinks if invoked as mdless or with -p, as recent less versions support OCS-8 hyperlinks (see GH-191).