From cf7310375d2f23c1c6569ca2aa11797fed759b68 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 23 Jul 2026 15:08:37 +0000 Subject: [PATCH 1/2] chore: release --- Cargo.lock | 4 ++-- markdown-reader/CHANGELOG.md | 22 ++++++++++++++++++++++ markdown-reader/Cargo.toml | 2 +- tui-markdown/CHANGELOG.md | 28 ++++++++++++++++++++++++++++ tui-markdown/Cargo.toml | 2 +- 5 files changed, 54 insertions(+), 4 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index b349ee8..fe5564b 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -954,7 +954,7 @@ dependencies = [ [[package]] name = "markdown-reader" -version = "0.1.28" +version = "0.1.29" dependencies = [ "clap", "color-eyre", @@ -2128,7 +2128,7 @@ dependencies = [ [[package]] name = "tui-markdown" -version = "0.3.8" +version = "0.3.9" dependencies = [ "ansi-to-tui", "document-features", diff --git a/markdown-reader/CHANGELOG.md b/markdown-reader/CHANGELOG.md index b517d5b..eae872b 100644 --- a/markdown-reader/CHANGELOG.md +++ b/markdown-reader/CHANGELOG.md @@ -4,6 +4,28 @@ All notable changes to this project will be documented in this file. ## [unreleased] +## [0.1.29](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.28...markdown-reader-v0.1.29) - 2026-07-23 + +### Added + +- *(mdr)* expose renderer options ([#164](https://github.com/joshka/tui-markdown/pull/164)) +- *(renderer)* render image fallbacks ([#155](https://github.com/joshka/tui-markdown/pull/155)) +- *(renderer)* render GFM tables ([#154](https://github.com/joshka/tui-markdown/pull/154)) +- *(renderer)* render GFM alerts ([#153](https://github.com/joshka/tui-markdown/pull/153)) +- *(renderer)* render definition lists +- *(renderer)* render footnotes +- *(renderer)* render raw HTML + +### Fixed + +- *(mdr)* count wrapped rows accurately ([#165](https://github.com/joshka/tui-markdown/pull/165)) +- *(renderer)* style link labels + +### Other + +- *(mdr)* add Markdown feature showcase ([#163](https://github.com/joshka/tui-markdown/pull/163)) +- *(renderer)* clarify rendering contracts ([#162](https://github.com/joshka/tui-markdown/pull/162)) + ## [0.1.28](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.27...markdown-reader-v0.1.28) - 2026-06-27 ### Other diff --git a/markdown-reader/Cargo.toml b/markdown-reader/Cargo.toml index e86b117..b35d15d 100644 --- a/markdown-reader/Cargo.toml +++ b/markdown-reader/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "markdown-reader" description = "A simple markdown reader that uses ratatui to render markdown files." -version = "0.1.28" +version = "0.1.29" documentation = "https://docs.rs/markdown-reader" categories = ["command-line-interface"] keywords = ["cli", "markdown", "ratatui", "terminal", "tui"] diff --git a/tui-markdown/CHANGELOG.md b/tui-markdown/CHANGELOG.md index c4062f0..1267b5d 100644 --- a/tui-markdown/CHANGELOG.md +++ b/tui-markdown/CHANGELOG.md @@ -4,6 +4,34 @@ All notable changes to this project will be documented in this file. ## [unreleased] +## [0.3.9](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.3.8...tui-markdown-v0.3.9) - 2026-07-23 + +### Added + +- *(options)* make stylesheet methods optional ([#168](https://github.com/joshka/tui-markdown/pull/168)) +- *(options)* configure Markdown symbols ([#167](https://github.com/joshka/tui-markdown/pull/167)) +- *(options)* load custom code themes ([#159](https://github.com/joshka/tui-markdown/pull/159)) +- *(options)* configure built-in code themes ([#158](https://github.com/joshka/tui-markdown/pull/158)) +- *(options)* configure image fallbacks ([#156](https://github.com/joshka/tui-markdown/pull/156)) +- *(renderer)* render image fallbacks ([#155](https://github.com/joshka/tui-markdown/pull/155)) +- *(renderer)* render GFM tables ([#154](https://github.com/joshka/tui-markdown/pull/154)) +- *(renderer)* render GFM alerts ([#153](https://github.com/joshka/tui-markdown/pull/153)) +- *(renderer)* render definition lists +- *(renderer)* render footnotes +- *(renderer)* render math +- *(renderer)* render raw HTML + +### Fixed + +- *(renderer)* keep styled list content inline ([#166](https://github.com/joshka/tui-markdown/pull/166)) +- *(renderer)* style link labels + +### Other + +- *(renderer)* clarify rendering contracts ([#162](https://github.com/joshka/tui-markdown/pull/162)) +- *(renderer)* organize Markdown constructs ([#161](https://github.com/joshka/tui-markdown/pull/161)) +- repair main validation baseline ([#160](https://github.com/joshka/tui-markdown/pull/160)) + ## [0.3.8](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.3.7...tui-markdown-v0.3.8) - 2026-06-27 ### Other diff --git a/tui-markdown/Cargo.toml b/tui-markdown/Cargo.toml index 63533ba..0c676b5 100644 --- a/tui-markdown/Cargo.toml +++ b/tui-markdown/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "tui-markdown" description = "A simple library for converting markdown to a Ratatui Text value" -version = "0.3.8" +version = "0.3.9" documentation = "https://docs.rs/tui-markdown" categories = ["command-line-interface"] keywords = ["cli", "markdown", "ratatui", "terminal", "tui"] From 857ba3137c78823b41c24e32d0c9701bac3273ec Mon Sep 17 00:00:00 2001 From: Josh McKinney Date: Thu, 23 Jul 2026 08:17:48 -0700 Subject: [PATCH 2/2] docs(changelog): rewrite release history Replace generated commit inventories across both crate changelogs with concise user-facing summaries. Preserve every published version and link summaries to their relevant pull requests. --- markdown-reader/CHANGELOG.md | 216 ++++++++++++++-------------------- tui-markdown/CHANGELOG.md | 219 ++++++++++++----------------------- 2 files changed, 165 insertions(+), 270 deletions(-) diff --git a/markdown-reader/CHANGELOG.md b/markdown-reader/CHANGELOG.md index eae872b..d2fdec3 100644 --- a/markdown-reader/CHANGELOG.md +++ b/markdown-reader/CHANGELOG.md @@ -6,229 +6,189 @@ All notable changes to this project will be documented in this file. ## [0.1.29](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.28...markdown-reader-v0.1.29) - 2026-07-23 -### Added - -- *(mdr)* expose renderer options ([#164](https://github.com/joshka/tui-markdown/pull/164)) -- *(renderer)* render image fallbacks ([#155](https://github.com/joshka/tui-markdown/pull/155)) -- *(renderer)* render GFM tables ([#154](https://github.com/joshka/tui-markdown/pull/154)) -- *(renderer)* render GFM alerts ([#153](https://github.com/joshka/tui-markdown/pull/153)) -- *(renderer)* render definition lists -- *(renderer)* render footnotes -- *(renderer)* render raw HTML - -### Fixed - -- *(mdr)* count wrapped rows accurately ([#165](https://github.com/joshka/tui-markdown/pull/165)) -- *(renderer)* style link labels - -### Other - -- *(mdr)* add Markdown feature showcase ([#163](https://github.com/joshka/tui-markdown/pull/163)) -- *(renderer)* clarify rendering contracts ([#162](https://github.com/joshka/tui-markdown/pull/162)) +- Render images, GFM tables and alerts, raw HTML, math, footnotes, and definition lists + ([#153], [#154], [#155]). +- Choose image fallback content and bundled or custom syntax-highlighting themes from the command + line ([#164]). +- Scroll wrapped documents to the end and keep the scrollbar accurate after terminal resizes + ([#165]). +- Style visible link labels consistently with their URLs. + +[#153]: https://github.com/joshka/tui-markdown/pull/153 +[#154]: https://github.com/joshka/tui-markdown/pull/154 +[#155]: https://github.com/joshka/tui-markdown/pull/155 +[#164]: https://github.com/joshka/tui-markdown/pull/164 +[#165]: https://github.com/joshka/tui-markdown/pull/165 ## [0.1.28](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.27...markdown-reader-v0.1.28) - 2026-06-27 -### Other +- Maintenance and dependency updates ([#116], [#120], [#132], [#133]). -- harden maintenance automation ([#133](https://github.com/joshka/tui-markdown/pull/133)) -- *(deps)* bump the cargo-dependencies group across 1 directory with 7 updates ([#132](https://github.com/joshka/tui-markdown/pull/132)) -- *(deps)* bump the cargo-dependencies group across 1 directory with 3 updates ([#120](https://github.com/joshka/tui-markdown/pull/120)) -- *(deps)* bump the cargo-dependencies group with 2 updates ([#116](https://github.com/joshka/tui-markdown/pull/116)) +[#116]: https://github.com/joshka/tui-markdown/pull/116 +[#120]: https://github.com/joshka/tui-markdown/pull/120 +[#132]: https://github.com/joshka/tui-markdown/pull/132 +[#133]: https://github.com/joshka/tui-markdown/pull/133 ## [0.1.27](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.26...markdown-reader-v0.1.27) - 2025-12-27 -### Other +- Refresh the supported-feature showcase and documentation ([#112], [#113]). +- Update compatibility to Ratatui 0.30 ([#105]). -- *(markdown-reader)* sync supported features ([#113](https://github.com/joshka/tui-markdown/pull/113)) -- *(markdown-reader)* expand TEST.md coverage ([#112](https://github.com/joshka/tui-markdown/pull/112)) -- *(deps)* update ratatui 0.30 ([#105](https://github.com/joshka/tui-markdown/pull/105)) -- *(deps)* bump the cargo-dependencies group across 1 directory with 4 updates ([#104](https://github.com/joshka/tui-markdown/pull/104)) -- *(deps)* bump clap from 4.5.50 to 4.5.51 in the cargo-dependencies group ([#102](https://github.com/joshka/tui-markdown/pull/102)) -- Add AGENTS.md ([#100](https://github.com/joshka/tui-markdown/pull/100)) +[#112]: https://github.com/joshka/tui-markdown/pull/112 +[#113]: https://github.com/joshka/tui-markdown/pull/113 +[#105]: https://github.com/joshka/tui-markdown/pull/105 ## [0.1.26](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.25...markdown-reader-v0.1.26) - 2025-11-03 -### Added - -- Implement task list support ([#99](https://github.com/joshka/tui-markdown/pull/99)) - -### Other +- Render task lists ([#99]). -- *(deps)* bump the cargo-dependencies group across 1 directory with 5 updates ([#97](https://github.com/joshka/tui-markdown/pull/97)) -- *(deps)* bump the cargo-dependencies group across 1 directory with 4 updates ([#94](https://github.com/joshka/tui-markdown/pull/94)) -- *(deps)* bump the cargo-dependencies group across 1 directory with 2 updates ([#91](https://github.com/joshka/tui-markdown/pull/91)) -- *(deps)* bump the cargo-dependencies group across 1 directory with 2 updates ([#86](https://github.com/joshka/tui-markdown/pull/86)) +[#99]: https://github.com/joshka/tui-markdown/pull/99 ## [0.1.25](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.24...markdown-reader-v0.1.25) - 2025-05-07 -### Other +- Maintenance and dependency updates ([#79]). -- *(deps)* bump the cargo-dependencies group across 1 directory with 5 updates ([#79](https://github.com/joshka/tui-markdown/pull/79)) +[#79]: https://github.com/joshka/tui-markdown/pull/79 ## [0.1.24](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.23...markdown-reader-v0.1.24) - 2025-05-07 -### Other +- Maintenance and dependency updates ([#73], [#81]). -- add rustfmt and reformat code ([#81](https://github.com/joshka/tui-markdown/pull/81)) -- *(deps)* bump clap in the cargo-dependencies group ([#73](https://github.com/joshka/tui-markdown/pull/73)) +[#73]: https://github.com/joshka/tui-markdown/pull/73 +[#81]: https://github.com/joshka/tui-markdown/pull/81 ## [0.1.23](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.22...markdown-reader-v0.1.23) - 2025-03-11 -### Other +- Maintenance and dependency updates ([#71]). -- *(deps)* bump the cargo-dependencies group with 2 updates ([#71](https://github.com/joshka/tui-markdown/pull/71)) +[#71]: https://github.com/joshka/tui-markdown/pull/71 ## [0.1.22](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.21...markdown-reader-v0.1.22) - 2025-03-09 -### Other +- Maintenance and dependency updates ([#64], [#66], [#70]). -- *(deps)* bump the cargo-dependencies group across 1 directory with 5 updates ([#70](https://github.com/joshka/tui-markdown/pull/70)) -- *(deps)* bump the cargo-dependencies group with 2 updates ([#66](https://github.com/joshka/tui-markdown/pull/66)) -- *(deps)* bump the cargo-dependencies group across 1 directory with 4 updates ([#64](https://github.com/joshka/tui-markdown/pull/64)) +[#64]: https://github.com/joshka/tui-markdown/pull/64 +[#66]: https://github.com/joshka/tui-markdown/pull/66 +[#70]: https://github.com/joshka/tui-markdown/pull/70 ## [0.1.21](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.20...markdown-reader-v0.1.21) - 2024-12-17 -### Other +- Maintenance and dependency updates ([#60]). -- *(deps)* bump the cargo-dependencies group with 5 updates (#60) +[#60]: https://github.com/joshka/tui-markdown/pull/60 ## [0.1.20](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.19...markdown-reader-v0.1.20) - 2024-11-20 -### Other +- Maintenance and dependency updates ([#58]). -- *(deps)* bump the cargo-dependencies group across 1 directory with 3 updates ([#58](https://github.com/joshka/tui-markdown/pull/58)) +[#58]: https://github.com/joshka/tui-markdown/pull/58 ## [0.1.19](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.18...markdown-reader-v0.1.19) - 2024-10-22 -### Other - -- update Cargo.lock dependencies +- Maintenance and dependency updates. ## [0.1.18](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.17...markdown-reader-v0.1.18) - 2024-10-13 -### Added - -- highlight code blocks ([#51](https://github.com/joshka/tui-markdown/pull/51)) - -### Other +- Syntax-highlight fenced code blocks ([#51]). -- *(deps)* bump clap in the cargo-dependencies group ([#52](https://github.com/joshka/tui-markdown/pull/52)) -- *(deps)* bump clap in the cargo-dependencies group ([#48](https://github.com/joshka/tui-markdown/pull/48)) +[#51]: https://github.com/joshka/tui-markdown/pull/51 ## [0.1.17](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.16...markdown-reader-v0.1.17) - 2024-09-20 -### Other - -- update readme demo image +- Refresh the demo. ## [0.1.16](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.15...markdown-reader-v0.1.16) - 2024-09-20 -### Other +- Render headings, blockquotes, ordered and nested lists, strong, emphasized, and struck-through + text, and Markdown line breaks ([#45]). +- Ignore unsupported Markdown constructs instead of panicking ([#45]). -- add tests, implement more markdown features, don't panic for unimplemented features ([#45](https://github.com/joshka/tui-markdown/pull/45)) +[#45]: https://github.com/joshka/tui-markdown/pull/45 ## [0.1.15](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.14...markdown-reader-v0.1.15) - 2024-09-20 -### Other +- Render unordered lists ([#44]). -- add support for unordered list ([#44](https://github.com/joshka/tui-markdown/pull/44)) -- *(deps)* bump the cargo-dependencies group with 2 updates ([#42](https://github.com/joshka/tui-markdown/pull/42)) +[#44]: https://github.com/joshka/tui-markdown/pull/44 ## [0.1.14](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.13...markdown-reader-v0.1.14) - 2024-08-06 -### Other -- use crossterm version re-exported from ratatui -- *(deps)* bump the cargo-dependencies group with 2 updates ([#36](https://github.com/joshka/tui-markdown/pull/36)) +- Maintenance and dependency updates ([#36]). + +[#36]: https://github.com/joshka/tui-markdown/pull/36 ## [0.1.13](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.12...markdown-reader-v0.1.13) - 2024-08-02 -### Other -- *(deps)* bump clap in the cargo-dependencies group ([#34](https://github.com/joshka/tui-markdown/pull/34)) +- Maintenance and dependency updates ([#34]). + +[#34]: https://github.com/joshka/tui-markdown/pull/34 ## [0.1.12](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.11...markdown-reader-v0.1.12) - 2024-07-15 -### Other -- *(deps)* bump clap in the cargo-dependencies group ([#32](https://github.com/joshka/tui-markdown/pull/32)) +- Maintenance and dependency updates ([#32]). + +[#32]: https://github.com/joshka/tui-markdown/pull/32 ## [0.1.11](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.10...markdown-reader-v0.1.11) - 2024-07-02 -### Other -- *(deps)* bump clap in the cargo-dependencies group ([#30](https://github.com/joshka/tui-markdown/pull/30)) +- Maintenance and dependency updates ([#30]). + +[#30]: https://github.com/joshka/tui-markdown/pull/30 ## [0.1.10](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.9...markdown-reader-v0.1.10) - 2024-06-24 -### Other -- *(deps)* bump ratatui in the cargo-dependencies group ([#29](https://github.com/joshka/tui-markdown/pull/29)) -- *(deps)* bump clap in the cargo-dependencies group ([#27](https://github.com/joshka/tui-markdown/pull/27)) +- Maintenance and dependency updates ([#27], [#29]). + +[#27]: https://github.com/joshka/tui-markdown/pull/27 +[#29]: https://github.com/joshka/tui-markdown/pull/29 ## [0.1.9](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.8...markdown-reader-v0.1.9) - 2024-06-08 -### Fixed -- link to crate pages +- Correct links to the crate documentation. ## [0.1.8](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.7...markdown-reader-v0.1.8) - 2024-05-22 -### Other -- *(deps)* bump the cargo-dependencies group with 3 updates ([#24](https://github.com/joshka/tui-markdown/pull/24)) +- Maintenance and dependency updates ([#24]). + +[#24]: https://github.com/joshka/tui-markdown/pull/24 ## [0.1.7](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.6...markdown-reader-v0.1.7) - 2024-04-24 -### Other -- *(deps)* bump ratatui from 0.26.1 to 0.26.2 ([#20](https://github.com/joshka/tui-markdown/pull/20)) -- *(deps)* bump time from 0.3.34 to 0.3.36 ([#21](https://github.com/joshka/tui-markdown/pull/21)) -- *(deps)* bump clap from 4.5.3 to 4.5.4 ([#17](https://github.com/joshka/tui-markdown/pull/17)) -- *(deps)* bump color-eyre from 0.6.2 to 0.6.3 ([#14](https://github.com/joshka/tui-markdown/pull/14)) -- *(deps)* bump clap from 4.5.2 to 4.5.3 ([#15](https://github.com/joshka/tui-markdown/pull/15)) +- Maintenance and dependency updates ([#14], [#15], [#17], [#20], [#21]). + +[#14]: https://github.com/joshka/tui-markdown/pull/14 +[#15]: https://github.com/joshka/tui-markdown/pull/15 +[#17]: https://github.com/joshka/tui-markdown/pull/17 +[#20]: https://github.com/joshka/tui-markdown/pull/20 +[#21]: https://github.com/joshka/tui-markdown/pull/21 ## [0.1.6](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.5...markdown-reader-v0.1.6) - 2024-03-12 -### Other -- *(deps)* bump mio from 0.8.10 to 0.8.11 in /markdown-reader ([#9](https://github.com/joshka/tui-markdown/pull/9)) -- *(deps)* bump clap from 4.5.1 to 4.5.2 ([#11](https://github.com/joshka/tui-markdown/pull/11)) +- Maintenance and dependency updates ([#9], [#11]). + +[#9]: https://github.com/joshka/tui-markdown/pull/9 +[#11]: https://github.com/joshka/tui-markdown/pull/11 ## [0.1.5](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.4...markdown-reader-v0.1.5) - 2024-02-29 -### Other -- update license info in readme files -- add a note about the experimental state -- bump copyright year +- Clarify licensing and the project's experimental status. ## [0.1.4](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.3...markdown-reader-v0.1.4) - 2024-02-27 -### Other -- make demo less easier to view +- Improve demo readability. ## [0.1.3](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.2...markdown-reader-v0.1.3) - 2024-02-27 -### Other -- fix more links / badges +- Correct documentation and badge links. ## [0.1.2](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.1...markdown-reader-v0.1.2) - 2024-02-27 -### Added -- add filename and pageUp/Down - -### Fixed -- urls in cargo.toml -- add pages down and up to scroll -- make scrollbar respect end of file - -### Other -- make logging scrollable +- Show the filename and add page-up and page-down navigation. +- Fix scrolling and the scrollbar at the end of a document. +- Keep logs scrollable. ## [0.1.1](https://github.com/joshka/tui-markdown/compare/markdown-reader-v0.1.0...markdown-reader-v0.1.1) - 2024-02-27 -### Added - -- Initial implementation of lib and tui - -### Fixed - -- tui-markdown crate dependency for markdown-reader - -### Other - -- add CHANGELOGs -- add demo for markdown-reader +- Introduce the `mdr` terminal Markdown reader. diff --git a/tui-markdown/CHANGELOG.md b/tui-markdown/CHANGELOG.md index 1267b5d..5aecbbe 100644 --- a/tui-markdown/CHANGELOG.md +++ b/tui-markdown/CHANGELOG.md @@ -6,233 +6,168 @@ All notable changes to this project will be documented in this file. ## [0.3.9](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.3.8...tui-markdown-v0.3.9) - 2026-07-23 -### Added - -- *(options)* make stylesheet methods optional ([#168](https://github.com/joshka/tui-markdown/pull/168)) -- *(options)* configure Markdown symbols ([#167](https://github.com/joshka/tui-markdown/pull/167)) -- *(options)* load custom code themes ([#159](https://github.com/joshka/tui-markdown/pull/159)) -- *(options)* configure built-in code themes ([#158](https://github.com/joshka/tui-markdown/pull/158)) -- *(options)* configure image fallbacks ([#156](https://github.com/joshka/tui-markdown/pull/156)) -- *(renderer)* render image fallbacks ([#155](https://github.com/joshka/tui-markdown/pull/155)) -- *(renderer)* render GFM tables ([#154](https://github.com/joshka/tui-markdown/pull/154)) -- *(renderer)* render GFM alerts ([#153](https://github.com/joshka/tui-markdown/pull/153)) -- *(renderer)* render definition lists -- *(renderer)* render footnotes -- *(renderer)* render math -- *(renderer)* render raw HTML - -### Fixed - -- *(renderer)* keep styled list content inline ([#166](https://github.com/joshka/tui-markdown/pull/166)) -- *(renderer)* style link labels - -### Other - -- *(renderer)* clarify rendering contracts ([#162](https://github.com/joshka/tui-markdown/pull/162)) -- *(renderer)* organize Markdown constructs ([#161](https://github.com/joshka/tui-markdown/pull/161)) -- repair main validation baseline ([#160](https://github.com/joshka/tui-markdown/pull/160)) +- Render GFM tables and alerts, raw HTML, math, footnotes, and definition lists ([#153], [#154]). +- Render configurable image text fallbacks using alt text or URLs ([#155], [#156]). +- Choose from bundled syntax-highlighting themes or load a custom TextMate theme ([#158], [#159]). +- Customize or hide heading markers and code-block fences, with style sheets that only override + the choices they need ([#167], [#168]). +- Style visible link labels consistently with their URLs. +- Keep styled list content beside its marker ([#166]). + +[#153]: https://github.com/joshka/tui-markdown/pull/153 +[#154]: https://github.com/joshka/tui-markdown/pull/154 +[#155]: https://github.com/joshka/tui-markdown/pull/155 +[#156]: https://github.com/joshka/tui-markdown/pull/156 +[#158]: https://github.com/joshka/tui-markdown/pull/158 +[#159]: https://github.com/joshka/tui-markdown/pull/159 +[#167]: https://github.com/joshka/tui-markdown/pull/167 +[#168]: https://github.com/joshka/tui-markdown/pull/168 +[#166]: https://github.com/joshka/tui-markdown/pull/166 ## [0.3.8](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.3.7...tui-markdown-v0.3.8) - 2026-06-27 -### Other +- Maintenance and dependency updates ([#116], [#120], [#132], [#133]). -- harden maintenance automation ([#133](https://github.com/joshka/tui-markdown/pull/133)) -- *(deps)* bump the cargo-dependencies group across 1 directory with 7 updates ([#132](https://github.com/joshka/tui-markdown/pull/132)) -- *(deps)* bump the cargo-dependencies group across 1 directory with 3 updates ([#120](https://github.com/joshka/tui-markdown/pull/120)) -- *(deps)* bump the cargo-dependencies group with 2 updates ([#116](https://github.com/joshka/tui-markdown/pull/116)) +[#116]: https://github.com/joshka/tui-markdown/pull/116 +[#120]: https://github.com/joshka/tui-markdown/pull/120 +[#132]: https://github.com/joshka/tui-markdown/pull/132 +[#133]: https://github.com/joshka/tui-markdown/pull/133 ## [0.3.7](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.3.6...tui-markdown-v0.3.7) - 2025-12-27 -### Added - -- *(renderer)* render metadata blocks ([#111](https://github.com/joshka/tui-markdown/pull/111)) -- *(renderer)* add subscript support ([#110](https://github.com/joshka/tui-markdown/pull/110)) -- *(renderer)* add superscript support ([#109](https://github.com/joshka/tui-markdown/pull/109)) -- *(renderer)* render soft line breaks ([#108](https://github.com/joshka/tui-markdown/pull/108)) -- *(renderer)* render horizontal rules ([#107](https://github.com/joshka/tui-markdown/pull/107)) -- *(renderer)* add stylesheet options API ([#80](https://github.com/joshka/tui-markdown/pull/80)) - -### Fixed - -- *(renderer)* add heading metadata rendering ([#106](https://github.com/joshka/tui-markdown/pull/106)) - -### Other +- Add custom style sheets and render metadata blocks, subscript, superscript, soft line breaks, and + horizontal rules ([#80], [#107], [#108], [#109], [#110], [#111]). +- Preserve heading metadata and update compatibility to Ratatui 0.30 ([#105], [#106]). -- *(deps)* update ratatui 0.30 ([#105](https://github.com/joshka/tui-markdown/pull/105)) -- *(deps)* bump the cargo-dependencies group across 1 directory with 4 updates ([#104](https://github.com/joshka/tui-markdown/pull/104)) +[#80]: https://github.com/joshka/tui-markdown/pull/80 +[#107]: https://github.com/joshka/tui-markdown/pull/107 +[#108]: https://github.com/joshka/tui-markdown/pull/108 +[#109]: https://github.com/joshka/tui-markdown/pull/109 +[#110]: https://github.com/joshka/tui-markdown/pull/110 +[#111]: https://github.com/joshka/tui-markdown/pull/111 +[#105]: https://github.com/joshka/tui-markdown/pull/105 +[#106]: https://github.com/joshka/tui-markdown/pull/106 ## [0.3.6](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.3.5...tui-markdown-v0.3.6) - 2025-11-03 -### Added +- Render task lists ([#99]). -- Implement task list support ([#99](https://github.com/joshka/tui-markdown/pull/99)) - -### Other - -- *(deps)* bump the cargo-dependencies group across 1 directory with 5 updates ([#97](https://github.com/joshka/tui-markdown/pull/97)) -- *(deps)* bump the cargo-dependencies group across 1 directory with 4 updates ([#94](https://github.com/joshka/tui-markdown/pull/94)) -- *(deps)* bump the cargo-dependencies group across 1 directory with 2 updates ([#91](https://github.com/joshka/tui-markdown/pull/91)) +[#99]: https://github.com/joshka/tui-markdown/pull/99 ## [0.3.5](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.3.4...tui-markdown-v0.3.5) - 2025-05-07 -### Other +- Maintenance and dependency updates ([#79]). -- *(deps)* bump the cargo-dependencies group across 1 directory with 5 updates ([#79](https://github.com/joshka/tui-markdown/pull/79)) +[#79]: https://github.com/joshka/tui-markdown/pull/79 ## [0.3.4](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.3.3...tui-markdown-v0.3.4) - 2025-05-07 -### Other +- Maintenance release ([#81], [#82]). -- remove unnecessary allowed lints ([#82](https://github.com/joshka/tui-markdown/pull/82)) -- add rustfmt and reformat code ([#81](https://github.com/joshka/tui-markdown/pull/81)) +[#81]: https://github.com/joshka/tui-markdown/pull/81 +[#82]: https://github.com/joshka/tui-markdown/pull/82 ## [0.3.3](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.3.2...tui-markdown-v0.3.3) - 2025-03-11 -### Other +- Maintenance and dependency updates ([#71]). -- *(deps)* bump the cargo-dependencies group with 2 updates ([#71](https://github.com/joshka/tui-markdown/pull/71)) +[#71]: https://github.com/joshka/tui-markdown/pull/71 ## [0.3.2](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.3.1...tui-markdown-v0.3.2) - 2025-03-09 -### Other +- Maintenance and dependency updates ([#64], [#66], [#70]). -- *(deps)* bump the cargo-dependencies group across 1 directory with 5 updates ([#70](https://github.com/joshka/tui-markdown/pull/70)) -- *(deps)* bump the cargo-dependencies group with 2 updates ([#66](https://github.com/joshka/tui-markdown/pull/66)) -- *(deps)* bump the cargo-dependencies group across 1 directory with 4 updates ([#64](https://github.com/joshka/tui-markdown/pull/64)) +[#64]: https://github.com/joshka/tui-markdown/pull/64 +[#66]: https://github.com/joshka/tui-markdown/pull/66 +[#70]: https://github.com/joshka/tui-markdown/pull/70 ## [0.3.1](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.3.0...tui-markdown-v0.3.1) - 2024-12-17 -### Added - -- Add support for links by replacing inner value (#62) - -### Other +- Render links as their visible label followed by the destination URL ([#62]). -- *(deps)* bump the cargo-dependencies group with 5 updates (#60) +[#62]: https://github.com/joshka/tui-markdown/pull/62 ## [0.3.0](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.2.12...tui-markdown-v0.3.0) - 2024-11-20 -### Other +- Update compatibility to Ratatui 0.29 ([#58]). -- *(deps)* bump the cargo-dependencies group across 1 directory with 3 updates ([#58](https://github.com/joshka/tui-markdown/pull/58)) +[#58]: https://github.com/joshka/tui-markdown/pull/58 ## [0.2.12](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.2.11...tui-markdown-v0.2.12) - 2024-10-22 -### Other +- Maintenance and dependency updates ([#54]). -- *(deps)* bump pulldown-cmark in the cargo-dependencies group ([#54](https://github.com/joshka/tui-markdown/pull/54)) +[#54]: https://github.com/joshka/tui-markdown/pull/54 ## [0.2.11](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.2.10...tui-markdown-v0.2.11) - 2024-10-13 -### Added +- Syntax-highlight fenced code blocks ([#51]). -- highlight code blocks ([#51](https://github.com/joshka/tui-markdown/pull/51)) - -### Other - -- *(deps)* bump rstest in the cargo-dependencies group ([#50](https://github.com/joshka/tui-markdown/pull/50)) +[#51]: https://github.com/joshka/tui-markdown/pull/51 ## [0.2.10](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.2.9...tui-markdown-v0.2.10) - 2024-09-20 -### Other +- Render headings, blockquotes, ordered and nested lists, strong, emphasized, and struck-through + text, and Markdown line breaks ([#45]). +- Ignore unsupported Markdown constructs instead of panicking ([#45]). -- add tests, implement more markdown features, don't panic for unimplemented features ([#45](https://github.com/joshka/tui-markdown/pull/45)) +[#45]: https://github.com/joshka/tui-markdown/pull/45 ## [0.2.9](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.2.8...tui-markdown-v0.2.9) - 2024-09-20 -### Other +- Render unordered lists ([#44]). -- add support for unordered list ([#44](https://github.com/joshka/tui-markdown/pull/44)) -- *(deps)* bump the cargo-dependencies group with 2 updates ([#42](https://github.com/joshka/tui-markdown/pull/42)) +[#44]: https://github.com/joshka/tui-markdown/pull/44 ## [0.2.8](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.2.7...tui-markdown-v0.2.8) - 2024-09-02 -### Other +- Maintenance and dependency updates ([#38], [#41]). -- *(deps)* bump the cargo-dependencies group across 1 directory with 3 updates ([#41](https://github.com/joshka/tui-markdown/pull/41)) -- *(deps)* bump the cargo-dependencies group with 2 updates ([#38](https://github.com/joshka/tui-markdown/pull/38)) +[#38]: https://github.com/joshka/tui-markdown/pull/38 +[#41]: https://github.com/joshka/tui-markdown/pull/41 ## [0.2.7](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.2.6...tui-markdown-v0.2.7) - 2024-08-06 -### Other - -- use crossterm version re-exported from ratatui +- Maintenance release. ## [0.2.6](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.2.5...tui-markdown-v0.2.6) - 2024-06-24 -### Other +- Update Ratatui compatibility ([#29]). -- *(deps)* bump ratatui in the cargo-dependencies group ([#29](https://github.com/joshka/tui-markdown/pull/29)) +[#29]: https://github.com/joshka/tui-markdown/pull/29 ## [0.2.5](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.2.4...tui-markdown-v0.2.5) - 2024-06-08 -### Fixed - -- link to crate pages +- Correct links to the crate documentation. ## [0.2.4](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.2.3...tui-markdown-v0.2.4) - 2024-05-22 -### Other +- Maintenance and dependency updates ([#24]). -- *(deps)* bump the cargo-dependencies group with 3 updates ([#24](https://github.com/joshka/tui-markdown/pull/24)) +[#24]: https://github.com/joshka/tui-markdown/pull/24 ## [0.2.3](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.2.2...tui-markdown-v0.2.3) - 2024-04-24 -### Other +- Update Markdown parser and Ratatui compatibility ([#19], [#20], [#23]). -- *(deps)* bump pulldown-cmark ([#23](https://github.com/joshka/tui-markdown/pull/23)) -- *(deps)* bump ratatui from 0.26.1 to 0.26.2 ([#20](https://github.com/joshka/tui-markdown/pull/20)) -- *(deps)* bump pulldown-cmark from 0.10.0 to 0.10.2 ([#19](https://github.com/joshka/tui-markdown/pull/19)) +[#19]: https://github.com/joshka/tui-markdown/pull/19 +[#20]: https://github.com/joshka/tui-markdown/pull/20 +[#23]: https://github.com/joshka/tui-markdown/pull/23 ## [0.2.2](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.2.1...tui-markdown-v0.2.2) - 2024-02-29 -### Other - -- update license info in readme files -- add a note about the experimental state +- Clarify licensing and the project's experimental status. ## [0.2.1](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.2.0...tui-markdown-v0.2.1) - 2024-02-27 -### Other - -- fix more links / badges -- fmt +- Correct documentation links and package metadata. ## [0.2.0](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.1.1...tui-markdown-v0.2.0) - 2024-02-27 -### Added - -- add filename and pageUp/Down -- support code blocks in tui-markdown - -### Fixed - -- Update urls in Cargo.toml ([#4](https://github.com/joshka/tui-markdown/pull/4)) - -### Other - -- add note about newlines +- Render fenced code blocks and preserve Markdown line breaks. ## [0.1.1](https://github.com/joshka/tui-markdown/compare/tui-markdown-v0.1.0...tui-markdown-v0.1.1) - 2024-02-27 -### Other - -- add CHANGELOGs - -### 🚀 Features - -- Initial implementation of lib and tui - -### 🐛 Bug Fixes - -- Tui-markdown crate dependency for markdown-reader - -### 📚 Documentation - -- Add demo for markdown-reader - -### ⚙️ Miscellaneous Tasks - -- Add ci and release workflows +- Introduce the Markdown-to-Ratatui renderer.