aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTong Sun <[email protected]>2023-05-03 12:49:53 -0400
committerTong Sun <[email protected]>2023-05-03 13:10:11 -0400
commitc7824a248f5b4504149169a0a8453155e698bbb4 (patch)
tree575b4532d381d5348caf1bccdcf00de92e714044 /README.md
parent- [#] v1.1.0 (diff)
downloadhtml2md-c7824a248f5b4504149169a0a8453155e698bbb4.tar.xz
html2md-c7824a248f5b4504149169a0a8453155e698bbb4.zip
- [#] update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 455ea2e..f880499 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,15 @@
- [Credits](#credits-1)
- [Similar Projects](#similar-projects)
+- [Install Debian/Ubuntu package](#install-debianubuntu-package)
+- [Download/install binaries](#downloadinstall-binaries)
+ - [The binary executables](#the-binary-executables)
+ - [Distro package](#distro-package)
+ - [Debian package](#debian-package)
+- [Install Source](#install-source)
+- [Author](#author)
+- [Contributors](#contributors-)
+
## html2md - HTML to Markdown converter
The `html2md` makes use of `github.com/JohannesKaufmann/html-to-markdown`
@@ -37,7 +46,7 @@ to convert HTML into Markdown, which is using an [HTML Parser](https://github.co
### $ html2md
```sh
HTML to Markdown
-Version 1.0.0 built on 2023-05-02
+Version 1.1.0 built on 2023-05-03
Copyright (C) 2020-2023, Tong Sun
HTML to Markdown converter on command line
@@ -51,6 +60,8 @@ Options:
-i, --in *The html/xml file to read from (or stdin)
-d, --domain Domain of the web page, needed for links when --in is not url
-s, --sel CSS/goquery selectors [=body]
+ -x, --excl Excluding CSS/goquery selectors
+ --xc Excluding all children nodes
-v, --verbose Verbose mode (Multiple -v options increase the verbosity.)
--opt-heading-style Option HeadingStyle
@@ -162,6 +173,10 @@ $ cat $GOPATH/src/github.com/JohannesKaufmann/html-to-markdown/testdata/TestPlug
- [lunny/html2md](https://github.com/lunny/html2md), which is using [regex instead of goquery](https://stackoverflow.com/a/1732454), which exhibits a few edge cases which prompted `github.com/JohannesKaufmann/html-to-markdown`
- [jaytaylor/html2text](https://github.com/jaytaylor/html2text), which is not converting to markdown but plain text.
+## Install Debian/Ubuntu package
+
+ sudo apt install -y html2md
+
## Download/install binaries
- The latest binary executables are available