Commit Graph

15 Commits

Author SHA1 Message Date
782bcf693e README: fix markdown formatting
- limit line length (does not affect rendering)
- add first-level header first
- converted google domain from hyperlinks into plain text
- add language specification for code fragments

Here is a command to run Markdown syntax check:

```
docker run --rm --network none -v "/$PWD:/markdown:ro" 06kellyjac/markdownlint-cli:0.21.0-alpine //markdown
```

All the changes above fixed the following list of errors:

```
/markdown/README.md:1 MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "## wait-for-it"]
/markdown/README.md:3 MD013/line-length Line length [Expected: 80; Actual: 280]
/markdown/README.md:7 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/markdown/README.md:21 MD013/line-length Line length [Expected: 80; Actual: 131]
/markdown/README.md:23 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/markdown/README.md:30 MD013/line-length Line length [Expected: 80; Actual: 124]
/markdown/README.md:32 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/markdown/README.md:39 MD013/line-length Line length [Expected: 80; Actual: 239]
/markdown/README.md:41 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/markdown/README.md:48 MD013/line-length Line length [Expected: 80; Actual: 185]
/markdown/README.md:50 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
```
2020-01-30 19:08:24 +03:00
e34c502a3e README: community section + mention Debian package 2018-08-18 15:54:06 -04:00
b638c19027 Update to README.md 2017-04-28 11:05:41 -07:00
ac372412a1 Update README.md 2017-03-13 00:44:51 -04:00
409b4a7bfd Update README.md 2017-03-13 00:44:01 -04:00
209be48eb6 Update README.md 2017-03-13 00:40:06 -04:00
e686775c5b readme update 2017-03-13 00:38:20 -04:00
e1f115e4ca Update README.md 2016-09-22 08:28:01 -04:00
1f3eb2c350 Update README.md 2016-09-22 06:39:34 -04:00
11afe7b6b9 Update README.md 2016-09-21 16:25:10 -04:00
4e94d7dbb1 more small doc fixes 2016-02-02 14:41:04 -05:00
bf194c8fb4 doc fixes 2016-02-02 14:33:27 -05:00
a150deb10a doc fixes 2016-02-02 14:31:55 -05:00
41deb2dbbe small fixes 2016-02-02 14:30:19 -05:00
e559a8e0fb initial commit 2016-02-02 14:23:09 -05:00