Skip to content

Commit f04fae8

Browse files
Emily Grace Sevillekbdharunnavarroaxel
authored
Add Command Line Interface Pages project support (#9845)
* Add `clip-view` page * Fix extensions * Add `md-to-clip` page * Fix description * Fix code example descriptions * Add better description for `clip-view` * Update pages/common/clip-view.md Co-authored-by: K.B.Dharun Krishna <[email protected]> * Update tool's urls * Apply suggestions from code review Co-authored-by: Axel Navarro <[email protected]> * Refresh `md-to-clip` page: - update url as repo has been renamed, today * Refresh `clip-view` page: - update url as repo has been renamed, today --------- Co-authored-by: K.B.Dharun Krishna <[email protected]> Co-authored-by: Axel Navarro <[email protected]>
1 parent a02542c commit f04fae8

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

pages/common/clip-view.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# clip-view
2+
3+
> Command Line Interface Pages render.
4+
> Render for a TlDr-like project with much a more extensive syntax and several render modes.
5+
> More information: <https://github.com/command-line-interface-pages/v2-tooling/tree/main/clip-view>.
6+
7+
- Render specific local pages:
8+
9+
`clip-view {{path/to/page1.clip path/to/page2.clip ...}}`
10+
11+
- Render specific remote pages:
12+
13+
`clip-view {{page_name1 page_name2 ...}}`
14+
15+
- Render pages by a specific render:
16+
17+
`clip-view --render {{tldr|tldr-colorful|docopt|docopt-colorful}} {{page_name1 page_name2 ...}}`
18+
19+
- Render pages with a specific color theme:
20+
21+
`clip-view --theme {{path/to/local_theme.yaml|remote_theme_name}} {{page_name1 page_name2 ...}}`
22+
23+
- Clear a page or theme cache:
24+
25+
`clip-view --clear-{{page|theme}}-cache`
26+
27+
- Display help:
28+
29+
`clip-view --help`
30+
31+
- Display version:
32+
33+
`clip-view --version`

pages/common/md-to-clip.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# md-to-clip
2+
3+
> Converter from tldr-pages to Command Line Interface Pages.
4+
> See also: `clip-view`.
5+
> More information: <https://github.com/command-line-interface-pages/v2-tooling/tree/main/md-to-clip>.
6+
7+
- Convert tldr-pages files and save into the same directories:
8+
9+
`md-to-clip {{path/to/page1.md path/to/page2.md ...}}`
10+
11+
- Convert tldr-pages files and save into a specific directory:
12+
13+
`md-to-clip --output-directory {{path/to/directory}} {{path/to/page1.md path/to/page2.md ...}}`
14+
15+
- Display help:
16+
17+
`md-to-clip --help`
18+
19+
- Display version:
20+
21+
`md-to-clip --version`

0 commit comments

Comments
 (0)