Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: fix markdown formatting #89

Merged
merged 1 commit into from
Aug 22, 2020

Conversation

kolomenkin
Copy link
Contributor

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: "```"]

- 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: "```"]
```
@kolomenkin
Copy link
Contributor Author

up

@douglas-gibbons douglas-gibbons merged commit 3995c04 into vishnubob:master Aug 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants