-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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 <kbdharunkrishna@gmail.com> * Update tool's urls * Apply suggestions from code review Co-authored-by: Axel Navarro <navarroaxel@gmail.com> * 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 <kbdharunkrishna@gmail.com> Co-authored-by: Axel Navarro <navarroaxel@gmail.com>
1 parent
a02542c
commit f04fae8
Showing
2 changed files
with
54 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# clip-view | ||
|
||
> Command Line Interface Pages render. | ||
> Render for a TlDr-like project with much a more extensive syntax and several render modes. | ||
> More information: <https://github.com/command-line-interface-pages/v2-tooling/tree/main/clip-view>. | ||
- Render specific local pages: | ||
|
||
`clip-view {{path/to/page1.clip path/to/page2.clip ...}}` | ||
|
||
- Render specific remote pages: | ||
|
||
`clip-view {{page_name1 page_name2 ...}}` | ||
|
||
- Render pages by a specific render: | ||
|
||
`clip-view --render {{tldr|tldr-colorful|docopt|docopt-colorful}} {{page_name1 page_name2 ...}}` | ||
|
||
- Render pages with a specific color theme: | ||
|
||
`clip-view --theme {{path/to/local_theme.yaml|remote_theme_name}} {{page_name1 page_name2 ...}}` | ||
|
||
- Clear a page or theme cache: | ||
|
||
`clip-view --clear-{{page|theme}}-cache` | ||
|
||
- Display help: | ||
|
||
`clip-view --help` | ||
|
||
- Display version: | ||
|
||
`clip-view --version` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# md-to-clip | ||
|
||
> Converter from tldr-pages to Command Line Interface Pages. | ||
> See also: `clip-view`. | ||
> More information: <https://github.com/command-line-interface-pages/v2-tooling/tree/main/md-to-clip>. | ||
- Convert tldr-pages files and save into the same directories: | ||
|
||
`md-to-clip {{path/to/page1.md path/to/page2.md ...}}` | ||
|
||
- Convert tldr-pages files and save into a specific directory: | ||
|
||
`md-to-clip --output-directory {{path/to/directory}} {{path/to/page1.md path/to/page2.md ...}}` | ||
|
||
- Display help: | ||
|
||
`md-to-clip --help` | ||
|
||
- Display version: | ||
|
||
`md-to-clip --version` |