Add Command Line Interface Pages (CLIP) page syntax examples (#1953)

* Add CLIP page syntax examples

* Update urls

* Fix errors
This commit is contained in:
Emily Grace Seville 2023-03-13 21:38:48 +10:00 committed by GitHub
parent cc9f2439cb
commit ab9ab48bc5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 45 additions and 0 deletions

45
clip.md Normal file
View File

@ -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)