Changelog

• e1c2387 cli: add hash to path on conflicting filename (#152)
• 20209ee table: fix br inside table causing early return (#150)
• 5bd9d3d update dependencies (#153)

1. Table Plugin

There is a new table plugin for v2 🥳

Use it in go:

conv := converter.NewConverter(
	converter.WithPlugins(
		base.NewBasePlugin(),
		commonmark.NewCommonmarkPlugin(),
		table.NewTablePlugin(), // <-- NEW
	),
)

Or --plugin-table for the CLI.

2. CLI File input and output

The CLI can now work directly with the filesystem:

$ html2markdown --input file.html --output file.md

$ html2markdown --input "src/*.html" --output "dist/"

Changelog

• 2d9c0c7 Bump github.com/agnivade/levenshtein from 1.2.0 to 1.2.1
• 2e1f9fd Bump github.com/muesli/termenv from 0.15.2 to 0.16.0
• 7054d30 Bump golang.org/x/net from 0.33.0 to 0.35.0
• 3d2ff94 Merge pull request #134 from JohannesKaufmann/improve-hard-line-break-2
• 73f4145 Merge pull request #135 from kinensake/fix-code-block-in-list
• 3f762f5 Merge pull request #139 from JohannesKaufmann/dependabot/go_modules/github.com/agnivade/levenshtein-1.2.1
• 7e02068 Merge pull request #141 from eko/patch-1
• 9c0410a Merge pull request #142 from JohannesKaufmann/dependabot/go_modules/golang.org/x/net-0.35.0
• 8a661fa Merge pull request #143 from JohannesKaufmann/dependabot/go_modules/github.com/muesli/termenv-0.16.0
• 43dad28 Removed invalid URL Printf warning
• 87f20d3 add code block in list test to golden files
• ceeec4b add test cases for link with newlines
• 7fca0c1 cli-add-table-plugin (#146)
• 7506c18 cli: added --input and --output flags (#137)
• d64b97a escape multiline func prefers hard line break
• 29db070 escape multiline uses other trim newline func
• 7db53b2 fix render code block in list
• 6b0ee58 improve handling of hard line breaks when removing newlines
• bd15218 plugin: added table plugin (#144)
• 6a359b1 remove unused constants in render list test
• f6aab8f restructure use of TrimConsecutiveNewlines func

Changelog

• a2a1219 Bump golang.org/x/net from 0.31.0 to 0.32.0
• 130f633 Merge pull request #121 from JohannesKaufmann/dependabot/go_modules/golang.org/x/net-0.32.0
• b3a74ca Merge pull request #124 from jcubic/remove-temp-file
• 5a52a80 Merge pull request #130 from JohannesKaufmann/improve-hard-line-break
• d904841 Merge pull request #131 from JohannesKaufmann/improve-nested-lists
• 14e6105 Merge pull request #132 from JohannesKaufmann/move-cli-command
• e128d43 add "go install" command to readme
• 5493558 add new testcases for
  inside blockquote
• fc29e14 add sponsor firecrawl to readme
• bbb7d5b change goreleaser config file to reflect cli folder move
• 057c7a9 commonmark: allow configuration of empty href/content behavior
• 891c5c1 commonmark: simplify naming of link behavior variables
• 0191495 domutils: added MoveListItems
• e5557f6 fix spelling mistakes
• 9344542 improved testcases for lists
• dda3eae move folder "cli" to "cli/html2markdown"
• ce09b2c new logic to remove consecutive newlines
• eca9d5c readme: add info about debian package & building from source
• 874d7d1 remove MacOSX temp file
• 54dfab5 remove old logic for unused marker
• bef143a remove unneeded code in marker package
• e40d875 render
  directly as hard-line-break
• bf93fdf update dependencies
• 947dc92 update go.sum
• df4e9cc use old EscapeMultiLine logic again

Changelog

• 43b9c81 github actions: publish deb packages

Changelog

• 5af1444 cli: add include & exclude selectors
• 4d6b2ff converter: allow base domain with url scheme
• c9b6dbc github: add issue forms

V2 Release

The new version v2 has been released 🚀

It is a rewrite from the ground up — even more accurate than the v1 version!

Some new features:

• Nested lists: Improved handling of deeply nested lists
• Hard line breaks: Proper support for <br /> tags
• Smart escaping: Only escape characters if they would be mistaken for markdown syntax
• Powerful Plugins: The new architecture allows plugins to hook into every part of the converting process.
• Improved Golang API: Simpler, more ergonomic API. For most cases htmltomarkdown.ConvertString(input) works out of the box.
• CLI: The cli is now part of the repository
• and more much...

Try it now

Since there are breaking changes, the path now has the "/v2" suffix. This also allows you to run v1 and v2 in parallel.

go get -u github.com/JohannesKaufmann/html-to-markdown/v2

package main

import (
	"fmt"
	"log"

	htmltomarkdown "github.com/JohannesKaufmann/html-to-markdown/v2"
)

func main() {
	input := `<strong>Bold Text</strong>`

	markdown, err := htmltomarkdown.ConvertString(input)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(markdown)
	// Output: **Bold Text**
}

Changelog

• a6926a0 add FAQ section to README
• f0108bb add base plugin
• 90318d6 add collapse testcase to cli
• 847f2d7 catch if base plugin is not registered
• c37ad42 connect collapse whitespace func to tag type map
• 270d8f4 converter: add WithEscapeMode
• 0c652f3 readme: add installation instructions
• 395858e remove element enum for absolute url function
• 7a77977 update dependencies

Changelog

• a03c20a goreleaser: publish to own homebrew-tap repo

Changelog

• b3cd870 add comments to ConvertX functions
• ac2bca7 change golang version to min 1.20
• 1e9b7b4 copy over MIT license
• 4e80d5d github actions: run on v2 branch
• 9e1b769 ignore example folder for test coverage
• e304501 inital commit of v2
• 67fcf58 remove old v1 files
• 8f50162 remove windows from testing matrix
• b00aaf9 update github actions workflow file to test different golang versions

• Add support for youtube-nocookie.com domain in YoutubeEmbed plugin

Thanks @devAbreu for submitting a PR 🙏