From ab9ab48bc57167c35e15614aed9dc8019b5ec50f Mon Sep 17 00:00:00 2001 From: Emily Grace Seville Date: Mon, 13 Mar 2023 21:38:48 +1000 Subject: [PATCH] Add Command Line Interface Pages (CLIP) page syntax examples (#1953) * Add CLIP page syntax examples * Update urls * Fix errors --- 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..5337d38c6 --- /dev/null +++ b/clip.md @@ -0,0 +1,45 @@ +--- +title: Command Line Interface Pages +category: CLI +layout: 2017/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/command-line-interface-pages/syntax/blob/main/type-specific/cli.md#primitive-placeholders) + +```md +- Delay in [s]econds: + +`sleep {int seconds: 2}s` +``` + +### [Primitive repeated placeholders](https://github.com/command-line-interface-pages/syntax/blob/main/type-specific/cli.md#repeated-primitive-placeholders) + +```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/command-line-interface-pages/v2-tooling/tree/main/clip-view) +* [Page's repository](https://github.com/command-line-interface-pages/cli-pages) +* [Syntax](https://github.com/command-line-interface-pages/syntax/blob/main/base.md)