Skip to content

Commit 869f13c

Browse files
committed
Add CLI snippet
1 parent 6d9e0f0 commit 869f13c

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
<snippet>
2+
<content><!-- Section for describing a command-line interface. -->
3+
4+
* * *
5+
6+
<section class="cli">
7+
8+
## CLI
9+
10+
<!-- CLI usage documentation. -->
11+
12+
<section class="usage">
13+
14+
### Usage
15+
16+
```text
17+
Usage: TODO [options]
18+
19+
Options:
20+
21+
-h, --help Print this message.
22+
-V, --version Print the package version.
23+
```
24+
25+
</section>
26+
27+
<!-- /.usage -->
28+
29+
<!-- CLI usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
30+
31+
<section class="notes">
32+
33+
</section>
34+
35+
<!-- /.notes -->
36+
37+
<!-- CLI usage examples. -->
38+
39+
<section class="examples">
40+
41+
### Examples
42+
43+
```bash
44+
$ TODO
45+
TODO
46+
```
47+
48+
</section>
49+
50+
<!-- /.examples -->
51+
52+
</section>
53+
54+
<!-- /.cli --></content>
55+
56+
<!-- Tab trigger to activate the snippet -->
57+
<tabTrigger>stdlib.cli</tabTrigger>
58+
59+
<!-- Scope the tab trigger will be active in -->
60+
<scope>text.html.markdown</scope>
61+
62+
<!-- Description to show in the menu -->
63+
<description>CLI documentation section</description>
64+
</snippet>

0 commit comments

Comments
 (0)