A CHANGELOG.md

@@ -0,0 +1,338 @@ 
+# v2.1.1 - 2026-05-22
+
+-   Fixed nimble metadata.
+-   Changed resulution of static libraries
+
+Changes
+
+# v2.1.0 - 2023-09-24
+
+This release is entirely contributed by @ZoomRmc – thank you so much for all the tidy ups and valuable additions to HastyScribe!
+
+-   Now multiple input files are handled correctly, including multiple glob patterns.
+-   IOError exit code changed to 5.
+-   output-file with multiple input files now ignored, preventing repeated overwrites.
+-   More events are now logged, including successful conversions and invalid arguments.
+-   HastyOptions now uses default fields for initialization.
+-   std/critbits are now imported to deduplicate input arguments.
+-   TMDMetaData now uses default object fields for initialization and is now an out parameter of markdown.md.
+-   Image download warning now outputs one log mark per message.
+-   compileDocument refactored to not use accumulation variables.
+-   hastyscribe_logo svg and img tag now prepared at compile time.
+-   Log level lvNotice now uses a dedicated color
+-   Normal log color changed from fgWhite to fgDefault
+-   utils.encode_image now uses strutils.multireplace
+-   Logic for some replacement operations relies on slightly tuned pegs, mostly to avoid multiple passes of findAll.
+-   style_tag is now a template
+-   Program now quits with an error if flags are given any value.
+-   Writing multiple files to stdout is now logged and delimited with an html-comment denoting the end of each file.
+-   Empty --output-file value is now an error.
+-   Optimized HastyScribe logo image.
+-   Improved logic to generate link styling.
+-   Implemented simple CSS minifier to reduce document size.
+
+Some new user-facing options are implemented: - Added option --iso is added to allow printing the date in ISO 8601 format in the html footer. - Added option --no-clobber to prevent overwrites. - Added option --output-dir allowing writing the resulting html files to a user-provided directory. If multiple given paths/globs resolve to files with colliding basenames, files are saved with a path hash suffix to prevent overwrites. This option takes precedence over --output-file.
+
+Changes
+
+# v2.0.0 - 2023-08-31
+
+This a new major release as it includes quite a few high-impact changes that may be considered breaking changes.
+
+Breaking Changes
+
+-   HastyScribe no longer embeds any web font in generated documents. As a result, generated HTML documents are considerably smaller in size.
+-   Removed possibility of dumping stylesheets via the --dump option. If you want to reuse HastyScribe styles, see the HastyStyles project.
+-   Badge classes must now start with badge-.
+-   There is no special badge/class to display the HastyScribe logo.
+
+Removed badges
+
+The following badges have been removed, mainly because they did not need to have a specific colors (and it is therefore possible to use fa- classes directly): - All payment and currency badges - red-circle - yellow-circle - green-circle - green-flag - yellow-flag - red-flag (renamed to flag) - gray-circle - copyright - registered - trademark - wifi - signal - circle - phone - barcode - envelope - fax - print - usb - globe - desktop - laptop - mobile - tablet
+
+New Functionalities
+
+-   Implemented support for footnotes (#77)
+-   Implemented support for HTML details and summary elements (#87)
+-   Added --noemebed option to prevent embedding of resources (but still generate a document, unlike with the --fragment option.
+-   Upgraded to Discount v2.2.7d.
+-   Upgraded to use FontAwesome v6.4.2 SVG icons
+-   Specific rules to display icons are automatically added to the document based on usage for:
+    -   badges
+    -   icons
+    -   notes
+    -   links
+
+New link icons
+
+The following link icons have been added: - slack - discord - codepen - etsy - stack-exchange - mastodon - file-zipper - file-pdf
+
+New badges
+
+The following new badges have been added: - flag - address - toxic - download - upload - network - org - code - react - angular - vuejs - ubuntu - suse - rust - redhat - rpi - markdown - go - fedora - debian - centos
+
+Updated badges
+
+The following textual badges have now been converted to display an icon instead: - fixme → red wrench - urgent → red stopwatch - draftcomment → green comments - todo → red clipboard-check - verify → red shield halved - deadline → red timeline
+
+Changes
+
+# v1.12.5 - 2021-07-03
+
+-   Upgraded Discount to v2.2.7.
+-   Fixed #82 — Linux binaries no longer require musl to be installed.
+-   Merged #83 — Last character no longer truncated (thanks @tomidery)
+-   Now building libdiscount natively when compiling, no longer using pre-built libraries.
+-   Added -v (–version) to display program version.
+-   Added -h to display help (also default if no files are specified).
+
+Changes
+
+# v1.12.4 - 2021-04-19
+
+-   Improvements to gc-safety by removing unnecessary procs (#78 – Thanks @tomidery)
+-   Enhanced public API by adding more public functions (#79 – Thanks @tomidery)
+-   Fixed PanDoc metadata checks (#80 – Thanks @tomidery)
+
+Changes
+
+# v1.12.3 - 2020-11-05
+
+-   Fixed #74
+-   Recompiled libmarkdown on Linux.
+
+Changes
+
+# v1.12.2 - 2020-10-25
+
+-   Updated Nim to v1.4.0
+
+Changes
+
+# v1.12.1 - 2020-08-30
+
+-   Fixed #73.
+
+Changes
+
+# v1.12.0 - 2020-04-16
+
+-   Upgraded FontAwesome to v5.13.0
+-   Upgraded Discount to v2.2.6
+-   No longer distributing pre-built binaries for ARM and x86 Linux
+-   Added support for Github-style checkboxes
+-   Added an additional width threshold for monitors bigger than 880px
+-   Changed font weights back to 400 and 700 to improve readability (Thanks Christof Schardt for proposing this)
+-   TOC links for chapters are now bold (Thanks Christof Schardt for proposing this)
+
+Changes
+
+# v1.11.0 - 2018-10-07
+
+-   Fixed Google link icon not displayed.
+-   Fixed style for sidebar icons.
+-   Fixed embedding of SVG images.
+-   Implemented new blank sidebar for custom sidebars.
+-   Partially fixed Nimble package structure.
+
+Changes
+
+# v1.10.0 - 2018-04-29
+
+-   Improved stylesheet.
+-   Now bundling italics and bold variants of Source Code Pro as well.
+-   Now using light and semibold variants of Source Sans Pro.
+-   New badges (js and freebsd).
+-   Minor fixes.
+
+Changes
+
+# v1.9.0 - 2018-04-27
+
+-   Added more badges and link types.
+-   Implemented custom markup to easily create HTML anchors.
+-   Fixed incorrect document date parsing (document date was set to the previous month).
+-   Fixed escaping of curly brackets in code blocks.
+
+Changes
+
+# v1.8.0 - 2018-03-11
+
+-   Now using Font Awesome 5 for all icons.
+-   Fixed compilation warnings with Nim 0.18.0.
+
+Changes
+
+# v1.7.1 - 2017-11-18
+
+-   Fixed transclusion bug.
+-   Fixed terminal block style.
+
+Changes
+
+# v1.7.0 - 2017-10-29
+
+-   Released a public Nim API to use HastyScribe as a library within a Nim program.
+-   Added a new –dump option to save HastyScribe stylesheets and fonts to the current directory.
+-   Minor refactoring and CSS fixes.
+
+Changes
+
+# v1.6.0 - 2017-03-12
+
+-   Implemented support for basic content transclusion.
+-   Implemented alternative syntax for snippets so that definitions are not evaluated to text.
+
+Changes
+
+# v1.5.0 - 2017-02-23
+
+-   Upgraded to version 2.2.2 of the Discount markdown library.
+-   Removed support for 32-bit Windows systems due to inability to test.
+-   Added the possibility to embed custom Javascript files.
+-   Upgraded to version 4.7.0 of FontAwesome.
+-   Now requiring Nifty to manage internal dependencies.
+
+Changes
+
+# v1.4.0 - 2016-10-23
+
+-   Implemented support for generating HTML fragments.
+-   Implemented support for library usage (undocumented for now).
+-   Refactoring.
+
+Changes
+
+# v1.3.0 - 2016-10-09
+
+-   Fixed bug on custom fields.
+-   Implemented substitution macros.
+
+Changes
+
+# v1.2.1 - 2016-06-24
+
+-   When watermark is used, links are now clickable.
+-   Text in terminal boxes now wraps for non-XS devices.
+
+Changes
+
+# v1.2.0 - 2016-06-11
+
+-   Implemented system fields to display time and date information.
+-   Implemented –field/ dynamic parameter to define custom fields via command line.
+-   Implemented –watermark parameter to embed a custom image as watermark.
+-   Code blocks and terminal sessions are now responsive.
+-   Tables are now set to 100% min-width.
+-   Images are now set to 100% max-width.
+-   Upgraded to FontAwesome v4.6.3.
+-   Now providing also binaries for Linux x64.
+
+Changes
+
+# v1.1.3 - 2015-09-06
+
+-   Fixed SIGSEGV errors in case of no TOCs or user CSS.
+
+Changes
+
+# v1.1.2 - 2015-08-23
+
+-   Upgraded to FontAwesome 4.4.0.
+-   Added a few new badges.
+-   Added styling for Wikipedia links.
+-   Other minor style tweaks.
+-   HastyScribe must now be recompiled to explicitly enable SSL support.
+
+Changes
+
+# v1.1.1 - 2015-07-18
+
+-   Improved badge styles.
+-   Added support for internal <style> tags.
+
+Changes
+
+# v1.1.0 - 2015-05-01
+
+-   Support for Nim 0.11.0
+-   Support for custom output file
+-   Support for custom stylesheet file
+-   Auto-downloading and embedding remote images
+
+Changes
+
+# v1.0.9 - 2015-01-02
+
+Nim 0.10.2 compatibility.
+
+Changes
+
+# v1.0.8 - 2014-12-26
+
+-   Implemented printed media support
+-   Fixed minor errors in documentation
+
+Changes
+
+# v1.0.7 - 2014-11-22
+
+Fixed issues with linking libmarkdown when installing via nimble.
+
+Changes
+
+# v1.0.6 - 2014-10-26
+
+-   Added support for the new Nimble package manager (formerly known as “Babel”)
+-   Now requiring Nimrod >= 0.9.6.
+
+Changes
+
+# v1.0.5 - 2014-10-18
+
+-   ARM Linux support (tested on Raspberry Pi Model B + Raspbian)
+-   Now allowing any file to be compiled (not only .md or .markdown)
+-   Minor documentation improvements
+-   Fixed MIME encoding extension problem for non-PNG images
+
+Changes
+
+# v1.0.4 - 2014-10-04
+
+-   Upgraded FontAwesome
+-   Badge enhancements
+
+Changes
+
+# v1.0.3 - 2014-09-12
+
+-   Now using narrow non-breakable space (\2027) after icons.
+-   No longer displaying icon before HastyScribe logo in the footer.
+-   Improved styling for terminal sessions.
+-   Added terminal-su class for super-user terminal sessions.
+-   No longer using border for inline code tag.
+-   Reduced line-height in code blocks.
+
+Changes
+
+# v1.0.2 - 2014-08-07
+
+-   Fixed issue with automatic date parsing
+-   Improved CSS for definition lists, added unstyled lists
+-   Added phone, email, fax and website badges
+
+Changes
+
+# v1.0.1 - 2014-08-01
+
+-   Added “Jump to Top” links to all headings (h2+)
+-   Added .babel file
+-   Ubuntu x86 pre-built binary
+
+Changes
+
+# v1.0 - 2014-07-20
+
+Initial release.
+
+Changes