README.e.md

{{render "license/shields" . "License" "MIT"}} {{template "badge/godoc" .}} {{template "badge/goreport" .}} {{template "badge/travis" .}}

{{toc 5}}

{{.Name}} - HTML to Markdown converter

The {{.Name}} makes use of github.com/JohannesKaufmann/html-to-markdown to convert HTML into Markdown, which is using an HTML Parser to avoid the use of regexp as much as possible, which can prevent some weird cases and allows it to be used for cases where the input is totally unknown.

Usage

$ {{exec "html2md" | color "sh"}}

Examples

Simplest form

$ html2md -i https://github.com/suntong/html2md | head -3
[Skip to content](#start-of-content)

[Homepage](https://github.com/)

Using goquery

The most useful feature is to use and pass a goquery selection to filter for the content you want.

$ {{.Name}} -i https://github.com/JohannesKaufmann/html-to-markdown -s "div.BorderGrid-row.hide-sm.hide-md > div"

The options and plugins

Works as expected:

$ echo '<strong>Bold Text</strong>' | html2md -i
**Bold Text**

$ echo '<strong>Bold Text</strong>' | html2md -i --opt-strong-delimiter="__"
__Bold Text__


$ echo '<ul><li><input type=checkbox checked>Checked!</li><li><input type=checkbox>Check Me!</li></ul>' | html2md -i -G
- [x] Checked!
- [ ] Check Me!

$ echo 'Only <del>blue ones</del> <s> left</s>' | html2md -i --plugin-strikethrough
Only ~blue ones~ ~left~

Testing the new table plugins

$ cat $GOPATH/src/github.com/JohannesKaufmann/html-to-markdown/testdata/TestPlugins/table/input.html | html2md -i -T | head -6
| Firstname | Lastname | Age |
| --- | --- | --- |
| Jill | Smith | 50 |
| Eve | Jackson | 94 |
| Empty |  |  |
| End |

$ cat $GOPATH/src/github.com/JohannesKaufmann/html-to-markdown/testdata/TestPlugins/table/input.html | html2md -i -T --domain example.com | diff -wU 1 $GOPATH/src/github.com/JohannesKaufmann/html-to-markdown/testdata/TestPlugins/table/output.table.golden -
---
@@ -41 +41,2 @@
 | `var` | b | c |
\ No newline at end of file
+

$ cat $GOPATH/src/github.com/JohannesKaufmann/html-to-markdown/testdata/TestPlugins/table/input.html | html2md -i --plugin-table-compat | head -6
Firstname · Lastname · Age

Jill · Smith · 50

Eve · Jackson · 94

$ cat $GOPATH/src/github.com/JohannesKaufmann/html-to-markdown/testdata/TestPlugins/table/input.html | html2md -i --plugin-table-compat --domain example.com | diff -wU 1 $GOPATH/src/github.com/JohannesKaufmann/html-to-markdown/testdata/TestPlugins/table/output.tablecompat.golden -
---
@@ -41 +41,2 @@
 `var` · b · c
\ No newline at end of file
+

Download/Install

Download binaries

• The latest binary executables are available right under the github release page
  https://github.com/suntong/{{.Name}}/releases
  as the result of the Continuous-Integration process.
• I.e., they are built during every git tagged push, automatically by GitHub Actions, right from the source code, truely WYSIWYG.
• The .deb, .rpm and .apk packages are readily available, as well as the executables for other Linux and Windows as well.
• Pick & choose the binary executable that suits your OS and its architecture. E.g., for Linux, it would most probably be the {{.Name}}_ver_linux_amd64.tar.gz file.
• Unzip it and put the executable somewhere in the PATH, after downloading it.

Install Source

To install the source code instead:

go get github.com/suntong/{{.Name}}

Credits & Authors

Credits

• Johannes Kaufmann's html-to-markdown that does the heavy lifting behind the scene.

Similar Projects

• turndown (js), a very good library written in javascript.
• lunny/html2md, which is using regex instead of goquery, which exhibits a few edge cases which prompted github.com/JohannesKaufmann/html-to-markdown
• jaytaylor/html2text, which is not converting to markdown but plain text.

Author(s) & Contributor(s)

Tong SUN

Powered by WireFrame, the one-stop wire-framing solution for Go cli based projects, from start to deploy.

All patches welcome.