mirror of
https://github.com/tldr-pages/tldr.git
synced 2026-08-28 11:25:16 +08:00
style-guide: add summary (#22054)
This commit is contained in:
@@ -481,6 +481,21 @@ To mark keypresses for TUI or GUI programs, use angle brackets `<` and `>`.
|
||||
- For consistency, we prefer generic wording `Display help` and `Display version` for these commands.
|
||||
- It is suggested to document the help and version examples if the command follows unconventional flags in platforms like Windows.
|
||||
|
||||
### Summary
|
||||
|
||||
Here's a quick table to summarize the syntax used in `tldr`:
|
||||
|
||||
| Syntax | Meaning |
|
||||
|--------|---------|
|
||||
| `{{ }}` | Placeholder |
|
||||
| `path/to/thing` | Filepath |
|
||||
| `{{[ \| ]}}` | Option placeholder |
|
||||
| `{{thing1 thing2 ...}}` | One or more arguments |
|
||||
| `{{thing1\|thing2\|...}}` | Mutually exclusive arguments |
|
||||
| `{{1..10}}` | Value range |
|
||||
| `<Ctrl c>` | Keypress |
|
||||
|
||||
|
||||
## Windows-Specific Rules
|
||||
|
||||
### General layout
|
||||
|
||||
Reference in New Issue
Block a user