Skip to content

Commit d63e2da

Browse files
committed
updating docs
1 parent c909ab2 commit d63e2da

40 files changed

+595
-563
lines changed

docs/csv2json.html

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,9 @@
2020
</nav>
2121

2222
<section>
23-
<h1>csv2json</h1>
23+
<h1>USAGE</h1>
2424

25-
<h2>USAGE</h2>
26-
27-
<pre><code>csv2json [OPTIONS]
28-
</code></pre>
25+
<h2>csv2json [OPTIONS]</h2>
2926

3027
<h2>SYNOPSIS</h2>
3128

@@ -35,20 +32,20 @@ <h2>SYNOPSIS</h2>
3532

3633
<h2>OPTIONS</h2>
3734

38-
<pre><code> -as-blobs output as one JSON blob per line
39-
-d set delimiter character
40-
-delimiter set delimiter character
41-
-h display help
42-
-help display help
43-
-i input filename
44-
-input input filename
45-
-l display license
46-
-license display license
47-
-o output filename
48-
-output output filename
49-
-use-header treat the first row as field names
50-
-v display version
51-
-version display version
35+
<pre><code>-as-blobs output as one JSON blob per line
36+
-d set the delimter character
37+
-delimiter set the delimter character
38+
-h display help
39+
-help display help
40+
-i input filename
41+
-input input filename
42+
-l display license
43+
-license display license
44+
-o output filename
45+
-output output filename
46+
-use-header treat the first row as field names
47+
-v display version
48+
-version display version
5249
</code></pre>
5350

5451
<h2>EXAMPLES</h2>
@@ -63,6 +60,8 @@ <h2>EXAMPLES</h2>
6360
<pre><code class="language-shell"> csv2json -as-blobs -i data1.csv
6461
</code></pre>
6562

63+
<p>csv2json v0.0.14</p>
64+
6665
</section>
6766

6867
<footer>

docs/csv2json.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11

2-
# csv2json
2+
# USAGE
33

4-
## USAGE
5-
6-
csv2json [OPTIONS]
4+
## csv2json [OPTIONS]
75

86
## SYNOPSIS
97

@@ -13,10 +11,9 @@ per line.
1311

1412
## OPTIONS
1513

16-
```
1714
-as-blobs output as one JSON blob per line
18-
-d set delimiter character
19-
-delimiter set delimiter character
15+
-d set the delimter character
16+
-delimiter set the delimter character
2017
-h display help
2118
-help display help
2219
-i input filename
@@ -28,7 +25,6 @@ per line.
2825
-use-header treat the first row as field names
2926
-v display version
3027
-version display version
31-
```
3228

3329
## EXAMPLES
3430

@@ -44,3 +40,5 @@ Convert data1.csv to JSON blobs, one line per blob
4440
csv2json -as-blobs -i data1.csv
4541
```
4642

43+
44+
csv2json v0.0.14

docs/csv2mdtable.html

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,9 @@
2020
</nav>
2121

2222
<section>
23-
<h1>csv2mdtable</h1>
23+
<h1>USAGE</h1>
2424

25-
<h2>USAGE</h2>
26-
27-
<pre><code>csv2mdtable [OPTIONS]
28-
</code></pre>
25+
<h2>csv2mdtable [OPTIONS]</h2>
2926

3027
<h2>SYNOPSIS</h2>
3128

@@ -34,30 +31,34 @@ <h2>SYNOPSIS</h2>
3431

3532
<h2>OPTIONS</h2>
3633

37-
<pre><code> -d set delimiter character
38-
-delimiter set delimiter character
39-
-h display help
40-
-help display help
41-
-i set input file
42-
-l display license
43-
-license display license
44-
-o set output file
45-
-v display version
46-
-version display version
34+
<pre><code>-d set delimiter character
35+
-delimiter set delimiter character
36+
-h display help
37+
-help display help
38+
-i input filename
39+
-input input filename
40+
-l display license
41+
-license display license
42+
-o output filename
43+
-output output filename
44+
-v display version
45+
-version display version
4746
</code></pre>
4847

4948
<h2>EXAMPLES</h2>
5049

5150
<p>Convert data1.csv to data1.md using Unix pipes.</p>
5251

53-
<pre><code> cat data1.csv | csv2mdtable &gt; data1.md
52+
<pre><code class="language-shell"> cat data1.csv | csv2mdtable &gt; data1.md
5453
</code></pre>
5554

5655
<p>Convert data1.csv to data1.md using options.</p>
5756

58-
<pre><code> csv2mdtable -i data1.csv -o data1.md
57+
<pre><code class="language-shell"> csv2mdtable -i data1.csv -o data1.md
5958
</code></pre>
6059

60+
<p>csv2mdtable v0.0.14</p>
61+
6162
</section>
6263

6364
<footer>

docs/csv2mdtable.md

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

2-
# csv2mdtable
2+
# USAGE
33

4-
## USAGE
5-
6-
csv2mdtable [OPTIONS]
4+
## csv2mdtable [OPTIONS]
75

86
## SYNOPSIS
97

@@ -12,30 +10,32 @@ table to stdout.
1210

1311
## OPTIONS
1412

15-
```
16-
-d set delimiter character
17-
-delimiter set delimiter character
13+
-d set delimiter character
14+
-delimiter set delimiter character
1815
-h display help
1916
-help display help
20-
-i set input file
17+
-i input filename
18+
-input input filename
2119
-l display license
2220
-license display license
23-
-o set output file
21+
-o output filename
22+
-output output filename
2423
-v display version
2524
-version display version
26-
```
2725

2826
## EXAMPLES
2927

3028
Convert data1.csv to data1.md using Unix pipes.
3129

32-
```
30+
```shell
3331
cat data1.csv | csv2mdtable > data1.md
3432
```
3533

3634
Convert data1.csv to data1.md using options.
3735

38-
```
36+
```shell
3937
csv2mdtable -i data1.csv -o data1.md
4038
```
4139

40+
41+
csv2mdtable v0.0.14

docs/csv2xlsx.html

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,9 @@
2020
</nav>
2121

2222
<section>
23-
<h1>csv2xlsx</h1>
23+
<h1>USAGE</h1>
2424

25-
<h2>USAGE</h2>
26-
27-
<pre><code>csv2xlsx [OPTIONS] WORKBOOK_NAME SHEET_NAME
28-
</code></pre>
25+
<h2>csv2xlsx [OPTIONS] WORKBOOK_NAME SHEET_NAME</h2>
2926

3027
<h2>SYNOPSIS</h2>
3128

@@ -34,34 +31,36 @@ <h2>SYNOPSIS</h2>
3431

3532
<h2>OPTIONS</h2>
3633

37-
<pre><code> -d set delimiter character
38-
-delimiter set delimiter character
39-
-h display help
40-
-help display help
41-
-i input filename (CSV content)
42-
-input input filename (CSV content)
43-
-l display license
44-
-license display license
45-
-sheet Sheet name to create/replace
46-
-v display version
47-
-version display version
48-
-workbook Workbook name
34+
<pre><code>-d set delimiter character (input)
35+
-delimiter set delimiter character (input)
36+
-h display help
37+
-help display help
38+
-i input filename (CSV content)
39+
-input input filename (CSV content)
40+
-l display license
41+
-license display license
42+
-sheet Sheet name to create/replace
43+
-v display version
44+
-version display version
45+
-workbook Workbook name
4946
</code></pre>
5047

5148
<h2>EXAMPLE</h2>
5249

53-
<pre><code> csv2xlsx -i data.csv MyWorkbook.xlsx 'My worksheet'
50+
<pre><code class="language-shell"> csv2xlsx -i data.csv MyWorkbook.xlsx 'My worksheet'
5451
</code></pre>
5552

5653
<p>This creates a new &lsquo;My worksheet&rsquo; in the Excel Workbook
5754
called &lsquo;MyWorkbook.xlsx&rsquo; with the contents of data.csv.</p>
5855

59-
<pre><code> cat data.csv | csv2xlsx MyWorkbook.xlsx 'My worksheet'
56+
<pre><code class="language-shell"> cat data.csv | csv2xlsx MyWorkbook.xlsx 'My worksheet'
6057
</code></pre>
6158

6259
<p>This does the same but the contents of data.csv are piped into
6360
the workbook&rsquo;s sheet.</p>
6461

62+
<p>csv2xlsx v0.0.14</p>
63+
6564
</section>
6665

6766
<footer>

docs/csv2xlsx.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11

2-
# csv2xlsx
2+
# USAGE
33

4-
## USAGE
5-
6-
csv2xlsx [OPTIONS] WORKBOOK_NAME SHEET_NAME
4+
## csv2xlsx [OPTIONS] WORKBOOK_NAME SHEET_NAME
75

86
## SYNOPSIS
97

@@ -12,9 +10,8 @@ If the Workbook does not exist then it is created.
1210

1311
## OPTIONS
1412

15-
```
16-
-d set delimiter character
17-
-delimiter set delimiter character
13+
-d set delimiter character (input)
14+
-delimiter set delimiter character (input)
1815
-h display help
1916
-help display help
2017
-i input filename (CSV content)
@@ -25,21 +22,22 @@ If the Workbook does not exist then it is created.
2522
-v display version
2623
-version display version
2724
-workbook Workbook name
28-
```
2925

3026
## EXAMPLE
3127

32-
```
28+
```shell
3329
csv2xlsx -i data.csv MyWorkbook.xlsx 'My worksheet'
3430
```
3531

3632
This creates a new 'My worksheet' in the Excel Workbook
3733
called 'MyWorkbook.xlsx' with the contents of data.csv.
3834

39-
```
35+
```shell
4036
cat data.csv | csv2xlsx MyWorkbook.xlsx 'My worksheet'
4137
```
4238

4339
This does the same but the contents of data.csv are piped into
4440
the workbook's sheet.
4541

42+
43+
csv2xlsx v0.0.14

0 commit comments

Comments
 (0)