diff --git a/README.md b/README.md index 3ddf26a3b..90ceb69f8 100644 --- a/README.md +++ b/README.md @@ -149,7 +149,7 @@ There is also a comprehensive - Your favourite command isn't covered? - You can think of more examples for an existing command? -All `tldr` pages are kept as markdown files right here in this repository, +All `tldr` pages are kept as Markdown files right here in this repository, so you can edit them directly and submit your changes as pull requests. All contributions are welcome! diff --git a/pages.ko/common/alex.md b/pages.ko/common/alex.md index 76804605f..6ff98c35b 100644 --- a/pages.ko/common/alex.md +++ b/pages.ko/common/alex.md @@ -16,6 +16,6 @@ `alex {{textfile.md}}` -- `example.md`를 제외한 모든 markdown 파일 분석: +- `example.md`를 제외한 모든 Markdown 파일 분석: `alex *.md !{{example.md}}` diff --git a/pages/common/alex.md b/pages/common/alex.md index 683191573..eadc8c5e0 100644 --- a/pages/common/alex.md +++ b/pages/common/alex.md @@ -16,6 +16,6 @@ `alex {{textfile.md}}` -- Analyze all markdown files except `example.md`: +- Analyze all Markdown files except `example.md`: `alex *.md !{{example.md}}` diff --git a/pages/common/gh-gist.md b/pages/common/gh-gist.md index 42f4d5a1a..66841b989 100644 --- a/pages/common/gh-gist.md +++ b/pages/common/gh-gist.md @@ -19,6 +19,6 @@ `gh gist list --limit {{int}}` -- View a Gist in the default browser without rendering markdown: +- View a Gist in the default browser without rendering Markdown: `gh gist view {{id_or_url}} --web --raw` diff --git a/pages/common/glow.md b/pages/common/glow.md index 0f9b37473..beec81d9e 100644 --- a/pages/common/glow.md +++ b/pages/common/glow.md @@ -7,11 +7,11 @@ `glow` -- Render a markdown file to the terminal: +- Render a Markdown file to the terminal: `glow {{path/to/file}}` -- View a markdown file using a paginator: +- View a Markdown file using a paginator: `glow -p {{path/to/file}}` diff --git a/pages/common/mdp.md b/pages/common/mdp.md index 5b19c1fa1..08826f0cb 100644 --- a/pages/common/mdp.md +++ b/pages/common/mdp.md @@ -1,9 +1,9 @@ # mdp -> A command-line based tool to make presentations from markdown files. +> A command-line based tool to make presentations from Markdown files. > More information: . -- Launch a presentation in the terminal from a markdown file: +- Launch a presentation in the terminal from a Markdown file: `mdp {{presentation.md}}` diff --git a/pages/common/roave-backward-compatibility-check.md b/pages/common/roave-backward-compatibility-check.md index f9de31707..5e9f344e6 100644 --- a/pages/common/roave-backward-compatibility-check.md +++ b/pages/common/roave-backward-compatibility-check.md @@ -15,6 +15,6 @@ `roave-backward-compatibility-check --to={{git_reference}}` -- Check for breaking changes and output to markdown: +- Check for breaking changes and output to Markdown: `roave-backward-compatibility-check --format=markdown > {{results.md}}` diff --git a/pages/linux/mdbook.md b/pages/linux/mdbook.md index 4d2a0bf80..f4495960c 100644 --- a/pages/linux/mdbook.md +++ b/pages/linux/mdbook.md @@ -19,6 +19,6 @@ `mdbook serve` -- Watch a set of markdown files and automatically build when a file is changed: +- Watch a set of Markdown files and automatically build when a file is changed: `mdbook watch` diff --git a/scripts/pdf/README.md b/scripts/pdf/README.md index 6ff29a61c..fe86360fe 100644 --- a/scripts/pdf/README.md +++ b/scripts/pdf/README.md @@ -15,7 +15,7 @@ This directory contains the script and related resources to generate a PDF docum ## Requirements -The PDF is generated by first converting the markdown files to HTML, and then rendering those HTML files as PDF. It depends on `markdown` and `weasyprint` libraries. To install the dependencies, run: +The PDF is generated by first converting the Markdown files to HTML, and then rendering those HTML files as PDF. It depends on `markdown` and `weasyprint` libraries. To install the dependencies, run: pip3 install -r requirements.txt