mirror of
https://github.com/tldr-pages/tldr.git
synced 2025-04-29 23:24:55 +02:00
change markdown to Markdown (#5049)
This commit is contained in:
parent
223e095d7d
commit
8b80cf08b8
9 changed files with 11 additions and 11 deletions
|
@ -149,7 +149,7 @@ There is also a comprehensive
|
||||||
- Your favourite command isn't covered?
|
- Your favourite command isn't covered?
|
||||||
- You can think of more examples for an existing command?
|
- 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.
|
so you can edit them directly and submit your changes as pull requests.
|
||||||
|
|
||||||
All contributions are welcome!
|
All contributions are welcome!
|
||||||
|
|
|
@ -16,6 +16,6 @@
|
||||||
|
|
||||||
`alex {{textfile.md}}`
|
`alex {{textfile.md}}`
|
||||||
|
|
||||||
- `example.md`를 제외한 모든 markdown 파일 분석:
|
- `example.md`를 제외한 모든 Markdown 파일 분석:
|
||||||
|
|
||||||
`alex *.md !{{example.md}}`
|
`alex *.md !{{example.md}}`
|
||||||
|
|
|
@ -16,6 +16,6 @@
|
||||||
|
|
||||||
`alex {{textfile.md}}`
|
`alex {{textfile.md}}`
|
||||||
|
|
||||||
- Analyze all markdown files except `example.md`:
|
- Analyze all Markdown files except `example.md`:
|
||||||
|
|
||||||
`alex *.md !{{example.md}}`
|
`alex *.md !{{example.md}}`
|
||||||
|
|
|
@ -19,6 +19,6 @@
|
||||||
|
|
||||||
`gh gist list --limit {{int}}`
|
`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`
|
`gh gist view {{id_or_url}} --web --raw`
|
||||||
|
|
|
@ -7,11 +7,11 @@
|
||||||
|
|
||||||
`glow`
|
`glow`
|
||||||
|
|
||||||
- Render a markdown file to the terminal:
|
- Render a Markdown file to the terminal:
|
||||||
|
|
||||||
`glow {{path/to/file}}`
|
`glow {{path/to/file}}`
|
||||||
|
|
||||||
- View a markdown file using a paginator:
|
- View a Markdown file using a paginator:
|
||||||
|
|
||||||
`glow -p {{path/to/file}}`
|
`glow -p {{path/to/file}}`
|
||||||
|
|
||||||
|
|
|
@ -1,9 +1,9 @@
|
||||||
# mdp
|
# 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: <https://github.com/visit1985/mdp>.
|
> More information: <https://github.com/visit1985/mdp>.
|
||||||
|
|
||||||
- Launch a presentation in the terminal from a markdown file:
|
- Launch a presentation in the terminal from a Markdown file:
|
||||||
|
|
||||||
`mdp {{presentation.md}}`
|
`mdp {{presentation.md}}`
|
||||||
|
|
||||||
|
|
|
@ -15,6 +15,6 @@
|
||||||
|
|
||||||
`roave-backward-compatibility-check --to={{git_reference}}`
|
`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}}`
|
`roave-backward-compatibility-check --format=markdown > {{results.md}}`
|
||||||
|
|
|
@ -19,6 +19,6 @@
|
||||||
|
|
||||||
`mdbook serve`
|
`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`
|
`mdbook watch`
|
||||||
|
|
|
@ -15,7 +15,7 @@ This directory contains the script and related resources to generate a PDF docum
|
||||||
|
|
||||||
## Requirements
|
## 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
|
pip3 install -r requirements.txt
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue