Skip to content

Commit 7494f65

Browse files
kgrytekgryte
committed
Replace comments with HTML section elements
1 parent fbd1aed commit 7494f65

File tree

2 files changed

+33
-16
lines changed

2 files changed

+33
-16
lines changed

‎tools/snippets/README.md‎

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@
33
> TODO
44
55

6-
<!-- <intro> -->
6+
<!-- Section to include introductory text. -->
7+
<section class="intro">
78

8-
<!-- </intro> -->
9+
</section>
10+
<!-- /.intro -->
911

10-
11-
<!-- <usage> -->
12+
<!-- Package usage documentation. -->
13+
<section class="usage">
1214

1315
## Usage
1416

@@ -25,10 +27,11 @@ var v = TODO( 0.0 );
2527
// returns TODO
2628
```
2729

28-
<!-- </usage> -->
29-
30+
</section>
31+
<!-- /.usage -->
3032

31-
<!-- <examples> -->
33+
<!-- Package usage examples. -->
34+
<section class="examples">
3235

3336
## Examples
3437

@@ -38,9 +41,17 @@ var TODO = require( '@stdlib/<TODO: module path>' );
3841
TODO
3942
```
4043

41-
<!-- </examples> -->
44+
</section>
45+
<!-- /.examples -->
46+
47+
<!-- Section to include cited references. -->
48+
<section class="references">
4249

50+
</section>
51+
<!-- /.references -->
4352

44-
<!-- <links> -->
53+
<!-- Section for all links. -->
54+
<section class="links">
4555

46-
<!-- </links> -->
56+
</section>
57+
<!-- /.links -->

‎tools/snippets/cli.md‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11

2-
<!-- <cli> -->
2+
<!-- Section for describing a commnd-line interface. -->
3+
<section class="cli">
34

45
---
56

67
## CLI
78

8-
<!-- <usage> -->
9+
<!-- CLI usage documentation. -->
10+
<section class="usage">
911

1012
### Usage
1113

@@ -18,9 +20,11 @@ Options:
1820
-V, --version Print the package version.
1921
```
2022

21-
<!-- </usage> -->
23+
</section>
24+
<!-- /.usage -->
2225

23-
<!-- <examples> -->
26+
<!-- CLI usage examples. -->
27+
<section class="examples">
2428

2529
### Examples
2630

@@ -29,6 +33,8 @@ $ TODO
2933
TODO
3034
```
3135

32-
<!-- </examples> -->
36+
</section>
37+
<!-- /.examples -->
3338

34-
<!-- </cli> -->
39+
</section>
40+
<!-- /.cli -->

0 commit comments

Comments
 (0)