Skip to content

Commit 094a514

Browse files
committed
- [#] prepare for separated README
1 parent f584bf7 commit 094a514

1 file changed

Lines changed: 12 additions & 50 deletions

File tree

README.e.md

Lines changed: 12 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,21 @@
11

2-
{{render "license/shields" . "License" "MIT"}}
3-
{{template "badge/godoc" .}}
4-
{{template "badge/goreport" .}}
5-
{{template "badge/travis" .}}
6-
[![PoweredBy WireFrame](https://github.com/go-easygen/wireframe/blob/master/PoweredBy-WireFrame-R.svg)](http://godoc.org/github.com/go-easygen/wireframe)
2+
## {{toc 5}}
73

8-
# {{toc 5}}
9-
10-
# {{.Name}} - HTML to Markdown converter
4+
## {{.Name}} - HTML to Markdown converter
115

126
The `{{.Name}}` makes use of `github.com/JohannesKaufmann/html-to-markdown`
137
to convert HTML into Markdown, which is using an [HTML Parser](https://github.com/PuerkitoBio/goquery) to avoid the use of `regexp` as much as possible, which can prevent some [weird cases](https://stackoverflow.com/a/1732454) and allows it to be used for cases where the input is totally unknown.
148

159
![gopher stading on top of a machine that converts a box of html to blocks of markdown](https://github.com/JohannesKaufmann/html-to-markdown/raw/master/logo.png)
1610

1711

18-
# Usage
12+
## Usage
1913

2014
### $ {{exec "html2md" | color "sh"}}
2115

22-
# Examples
16+
### Examples
2317

24-
## Simplest form
18+
#### Simplest form
2519

2620
```md
2721
$ html2md -i https://github.com/suntong/html2md | head -3
@@ -30,7 +24,7 @@ $ html2md -i https://github.com/suntong/html2md | head -3
3024
[Homepage](https://github.com/)
3125
```
3226

33-
## Using goquery
27+
#### Using goquery
3428

3529
The most useful feature is to use and pass a [goquery](https://github.com/PuerkitoBio/goquery) selection to filter for the content you want.
3630

@@ -39,7 +33,7 @@ $ {{.Name}} -i https://github.com/JohannesKaufmann/html-to-markdown -s "div.Bord
3933
```
4034

4135

42-
## The options and plugins
36+
### The options and plugins
4337

4438
Works as expected:
4539

@@ -59,7 +53,7 @@ $ echo 'Only <del>blue ones</del> <s> left</s>' | html2md -i --plugin-strikethro
5953
Only ~blue ones~ ~left~
6054
```
6155

62-
## Testing the new table plugins
56+
#### Testing the new table plugins
6357

6458
```sh
6559
$ cat $GOPATH/src/github.com/JohannesKaufmann/html-to-markdown/testdata/TestPlugins/table/input.html | html2md -i -T | head -6
@@ -92,47 +86,15 @@ $ cat $GOPATH/src/github.com/JohannesKaufmann/html-to-markdown/testdata/TestPlug
9286
+
9387
```
9488

95-
# Download/Install
96-
97-
98-
## Download binaries
99-
100-
- The latest binary executables are available right under the github release page
101-
https://github.com/suntong/{{.Name}}/releases
102-
as the result of the Continuous-Integration process.
103-
- I.e., they are built during every git tagged push, automatically by [GitHub Actions](https://github.com/features/actions), right from the source code, truely WYSIWYG.
104-
- The `.deb`, `.rpm` and `.apk` packages are readily available, as well as the executables for other Linux and Windows as well.
105-
- 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.
106-
- Unzip it and put the executable somewhere in the PATH, after downloading it.
107-
108-
109-
## Install Source
110-
111-
To install the source code instead:
112-
113-
```
114-
go get github.com/suntong/{{.Name}}
115-
```
116-
117-
# Credits & Authors
89+
## Credits
11890

11991

120-
## Credits
92+
### Credits
12193

122-
- [Johannes Kaufmann's html-to-markdown](github.com/JohannesKaufmann/html-to-markdown) that does the heavy lifting behind the scene.
94+
- [Johannes Kaufmann's html-to-markdown](https://github.com/JohannesKaufmann/html-to-markdown) that does the heavy lifting behind the scene.
12395

124-
## Similar Projects
96+
### Similar Projects
12597

12698
- [turndown (js)](https://github.com/domchristie/turndown), a very good library written in javascript.
12799
- [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`
128100
- [jaytaylor/html2text](https://github.com/jaytaylor/html2text), which is not converting to markdown but plain text.
129-
130-
## Author(s) & Contributor(s)
131-
132-
Tong SUN
133-
![suntong from cpan.org](https://img.shields.io/badge/suntong-%40cpan.org-lightgrey.svg "suntong from cpan.org")
134-
135-
[![PoweredBy WireFrame](https://github.com/go-easygen/wireframe/blob/master/PoweredBy-WireFrame-Y.svg)](http://godoc.org/github.com/go-easygen/wireframe)
136-
_Powered by_ [**WireFrame**](https://github.com/go-easygen/wireframe), the _one-stop wire-framing solution_ for Go cli based projects, from start to deploy.
137-
138-
All patches welcome.

0 commit comments

Comments
 (0)