Skip to content

Commit fcfce82

Browse files
committed
Updated README.md files for renderers.
1 parent 4c4d68c commit fcfce82

File tree

7 files changed

+51
-0
lines changed

7 files changed

+51
-0
lines changed

packages/doxdox-renderer-bootstrap/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ $ npm install doxdox-cli@v4.0.0-preview.22 doxdox-renderer-bootstrap@v4.0.0-prev
1414

1515
## Usage
1616

17+
```bash
18+
$ doxdox -r bootstrap > docs.html
19+
```
20+
21+
or
22+
1723
```bash
1824
$ doxdox -r bootstrap -o docs.html
1925
```

packages/doxdox-renderer-dash/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,15 @@ $ npm install doxdox-cli@v4.0.0-preview.22 doxdox-renderer-dash@v4.0.0-preview.2
1414

1515
## Usage
1616

17+
> [!WARNING]
18+
> The `-o`/`--output` flag is required when using this renderer on Windows PowerShell.
19+
20+
```bash
21+
$ doxdox -r dash > docs.zip
22+
```
23+
24+
or
25+
1726
```bash
1827
$ doxdox -r dash -o docs.zip
1928
```

packages/doxdox-renderer-github-wiki/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,15 @@ $ npm install doxdox-cli@v4.0.0-preview.22 doxdox-renderer-github-wiki@v4.0.0-pr
1414

1515
## Usage
1616

17+
> [!WARNING]
18+
> The `-o`/`--output` flag is required when using this renderer on Windows PowerShell.
19+
20+
```bash
21+
$ doxdox -r github-wiki > docs.zip
22+
```
23+
24+
or
25+
1726
```bash
1827
$ doxdox -r github-wiki -o docs.zip
1928
```

packages/doxdox-renderer-json/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ $ npm install doxdox-cli@v4.0.0-preview.22 doxdox-renderer-json@v4.0.0-preview.2
1414

1515
## Usage
1616

17+
```bash
18+
$ doxdox -r json > docs.json
19+
```
20+
21+
or
22+
1723
```bash
1824
$ doxdox -r json -o docs.json
1925
```

packages/doxdox-renderer-markdown/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ $ npm install doxdox-cli@v4.0.0-preview.22 doxdox-renderer-markdown@v4.0.0-previ
1414

1515
## Usage
1616

17+
```bash
18+
$ doxdox -r markdown > docs.md
19+
```
20+
21+
or
22+
1723
```bash
1824
$ doxdox -r markdown -o docs.md
1925
```

packages/doxdox-renderer-pdf/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,15 @@ $ npm install doxdox-cli@v4.0.0-preview.22 doxdox-renderer-pdf@v4.0.0-preview.22
1414

1515
## Usage
1616

17+
> [!WARNING]
18+
> The `-o`/`--output` flag is required when using this renderer on Windows PowerShell.
19+
20+
```bash
21+
$ doxdox -r pdf > docs.pdf
22+
```
23+
24+
or
25+
1726
```bash
1827
$ doxdox -r pdf -o docs.pdf
1928
```

packages/doxdox-renderer-template/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ $ npm install doxdox-cli@v4.0.0-preview.22 doxdox-renderer-template@v4.0.0-previ
1414

1515
## Usage
1616

17+
```bash
18+
$ doxdox -r template > docs.txt
19+
```
20+
21+
or
22+
1723
```bash
1824
$ doxdox -r template -o docs.txt
1925
```

0 commit comments

Comments
 (0)