88 lines (64 loc) · 4.62 KB

Changelog

All notable changes to this project will be documented in this file.

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

NOTE: As semantic versioning states all 0.y.z releases can contain breaking changes in API (flags, gRPC API, any backward compatibility)

We use breaking word for marking changes that are not backward compatible (relates only to v0.y.z releases.)

Unreleased

Added

#86 Add configuration options for sending HTTP requests (to help avoid intermittent errors).
#180 Allow ignoring/re-anchoring local links via localValidator.

Fixed

#84 Allow quotes in first header.
#181 Add support for repeated markdown headers.

v0.9.0

Added

#20 Add quotes to frontmatter
#25 Add sed testcase for mdox-exec
#29 Add transform command
#33 Add links.validate.config flag
#40 Add retries to link checking
#46 Add support for formatting in-md HTML and comments
#47 Add backMatter support
#48 Add file line numbers to errors
#49 Add CLI spinner and colored diff
#53 Add profiling and metrics
#56 Add benchmarks
#58 Add option to preserve header (popHeader)
#66 Add support for email mailto: links
#68 Add newline check for mdox-exec output
#69 Add timeout option to links.validate.config
#71 Add Origin.Path to transform template
#75 Add soft-wraps flag to preserve soft line breaks
#76 Add linkPrefixForNonMarkdownResources to transform config
#78 Add retry for 0 StatusCode

Fixed

#16 Fixed frontmatter issues
#17 Fixed mdox-exec issues with --help by adding mdox-expect-exit-code code block directive
#21 Fixed local anchor link issue
#26 Fixed same link in different file error
#31 Fixed clilog file names for link errors
#32 Added support for modifying links in image URLs and fixed linking when adding extra files from outside.
#41 Fixed mdox gen errors on command with = inside (common case)
#44 Fixed dash header ID
#52 Fixed i18n section links
#62 Fixed link line number in errors

Changed

#27 Change from mdox-gen-exec to mdox-exec
#39 Change to efficientgo/tools/extkingpin for pathOrContent flags
#45 Change transform config flag to pathOrContent
#59 Make GitHub validator smarter

v0.2.1

Fixed

Missing dependency issue

v0.2.0

Changed

Fixed whitespace bug in code blocks.
Add support for links.
Changed --links.localise.address-regex flag to --links.localize.address-regex
Changed --links.anchor-dir flag to --anchor-dir.
Changed --links.validate.address-regex flag to --links.validate.without-address-regex.
Allow anchor dir to be relative.
Improved error formatting.
By default front matter is getting formatted now.

v0.1.0

Initial release.