Skip to content

Releases: Kunde21/markdownfmt

v3.1.0

06 Jan 16:22
e8fe457
Compare
Choose a tag to compare

Added

  • markdown: Add WithListIndentStyle option to control how blocks inside list items are indented.
  • cli: Add -list-indent-style flag to control this option from the CLI.

v3.0.0

14 Dec 23:27
Compare
Choose a tag to compare

This is a new major release. You can install it using the module path: github.com/Kunde21/markdownfmt/v3.

Note that we moved some packages in this release. The import paths for different components are now:

Component Old import path New import path
CLI github.com/Kunde21/markdownfmt/v2 github.com/Kunde21/markdownfmt/v3/cmd/markdownfmt
markdownfmt github.com/Kunde21/markdownfmt/v2/markdownfmt github.com/Kunde21/markdownfmt/v3
markdown github.com/Kunde21/markdownfmt/v2/markdown github.com/Kunde21/markdownfmt/v3/markdown

Added

  • Support raw HTML blocks.
  • Add WithSoftWraps to retain soft line breaks.
  • Add WithCodeFormatters to supply custom formatters for code blocks, and a GoCodeFormatter built-in formatter.
  • Add WithEmphasisToken and WithStrongToken to change the tokens used for bold and italic text.
  • markdownfmt CLI: Add -gofmt flag to enable reformatting of Go source code.

Removed

  • Deleted markdownfmt.NewParser. If you need this, use markdownfmt.NewGoldmark to get a goldmark.Markdown and extract the parser from that.

Changed

  • Move markdownfmt CLI to cmd/markdownfmt.
  • Move markdownfmt package to module root.
  • Change module import path to github.com/Kunde21/markdownfmt/v3.
  • Don't modify code inside fenced code by default. Supply the WithCodeFormatters option to the Renderer to enable reformatting of source code.
  • markdownfmt CLI: Don't shell out to diff in -d mode.
  • markdownfmt CLI: Don't reformat Go source code inside fenced code blocks. Opt into this functionality with the -gofmt flag.
  • Renderer.AddOptions is no longer a no-op. It now extracts and applies Markdown-specific options from the provided list.

Fixed

  • Fix formatting of whitespace in code blocks.
  • Retain start positions for ordered lists.
  • Significant performance improvements to rendering.

Happy 2021

26 Jan 10:57
e73bd7c
Compare
Choose a tag to compare

Starting the new year with updated dependencies and some new supported elements.

TaskCheckBox and Autolink (Github Flavor) are now supported and formatted (#19)
Optional use of Hash headers is now available, default is underline (#26)
Attributes other than id are sorted and formatted, don't lose your classes anymore (#31)

Beyond that, there has been a major cleanup effort to simplify the code and reduce extra buffering.

Thank you to @bwplotka and @karelbilek for the contributions!

v0.1.2: fix markdownfmt adds trailing blank lines to document (#1)

03 Sep 12:29
Compare
Choose a tag to compare
* fix markdownfmt adds trailing blank lines to document

* fix markdownfmt adds trailing blank lines to document