Skip to content

Commit 1ec2901

Browse files
authored
tldr-lint: update page (#19198)
1 parent 8acce9b commit 1ec2901

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

pages/common/tldr-lint.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
11
# tldr-lint
22

33
> Lint and format `tldr` pages.
4-
> More information: <https://github.com/tldr-pages/tldr-lint>.
4+
> Note: `tldrl` can be used as an alias for `tldr-lint`.
5+
> More information: <https://github.com/tldr-pages/tldr-lint#usage>.
56
6-
- Lint all pages:
7+
- Lint a single page or all pages in a directory:
78

8-
`tldr-lint {{pages_directory}}`
9+
`tldr-lint {{path/to/page_or_directory}}`
10+
11+
- Ignore specific `tldr-lint` error codes while linting:
12+
13+
`tldr-lint {{[-I|--ignore]}} {{TLDR001,TLDR002,...}}`
914

1015
- Format a specific page to `stdout`:
1116

12-
`tldr-lint --format {{page.md}}`
17+
`tldr-lint {{[-f|--format]}} {{path/to/page.md}}`
1318

14-
- Format all pages in place:
19+
- Format a page in place:
1520

16-
`tldr-lint --format --in-place {{pages_directory}}`
21+
`tldr-lint {{[-f|--format]}} {{[-i|--in-place]}} {{path/to/page.md}}`

0 commit comments

Comments
 (0)