From e8ee0bebc41e11bbe14abacbdfb58d8edf43edbc Mon Sep 17 00:00:00 2001 From: EmilySeville7cfg Date: Thu, 9 Feb 2023 22:06:35 +1000 Subject: [PATCH] Add CLIP page syntax examples --- clip.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 clip.md diff --git a/clip.md b/clip.md new file mode 100644 index 000000000..eb5752c18 --- /dev/null +++ b/clip.md @@ -0,0 +1,45 @@ +--- +title: Command Line Interface Pages +category: CLI +layout: 2023/sheet +tags: [Featured] +updated: 2023-02-23 +keywords: + - CLI +--- + +### Page layout + +```md +# command + +> Some command description +> More information: https://some/link/to/url + +- Some code description: + +`command argument1 argument2` +``` + +### [Primitive placeholders](https://github.com/emilyseville7cfg-better-tldr/syntax/blob/main/syntax.md#page-examples) + +```md +- Delay in [s]econds: + +`sleep {int seconds: 2}s` +``` + +### [Primitive repeated placeholders](https://github.com/emilyseville7cfg-better-tldr/syntax/blob/main/syntax.md#page-examples) + +```md +- [c]reate an archive and write it to a [f]ile: + +`tar {option mode: --create, -c} {option: --file, -f} {/?file archive: target.tar} {/?path+ input}` +``` + +### Also see +{: .-one-column} + +* [Render](https://github.com/emilyseville7cfg-better-tldr/prototypes/tree/main/clip-view) +* [Page's repository](https://github.com/emilyseville7cfg-better-tldr/cli-pages) +* [Syntax](https://github.com/emilyseville7cfg-better-tldr/syntax/blob/main/syntax.md)