From f04fae80aac5852a23f81dce01af9dc141ac14da Mon Sep 17 00:00:00 2001 From: Emily Grace Seville Date: Wed, 1 Mar 2023 21:55:35 +1000 Subject: [PATCH] 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 * Update tool's urls * Apply suggestions from code review Co-authored-by: Axel Navarro * 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 Co-authored-by: Axel Navarro --- pages/common/clip-view.md | 33 +++++++++++++++++++++++++++++++++ pages/common/md-to-clip.md | 21 +++++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100644 pages/common/clip-view.md create mode 100644 pages/common/md-to-clip.md diff --git a/pages/common/clip-view.md b/pages/common/clip-view.md new file mode 100644 index 0000000000..941c410877 --- /dev/null +++ b/pages/common/clip-view.md @@ -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: . + +- 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` diff --git a/pages/common/md-to-clip.md b/pages/common/md-to-clip.md new file mode 100644 index 0000000000..bf631a19c2 --- /dev/null +++ b/pages/common/md-to-clip.md @@ -0,0 +1,21 @@ +# md-to-clip + +> Converter from tldr-pages to Command Line Interface Pages. +> See also: `clip-view`. +> More information: . + +- 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`