File tree Expand file tree Collapse file tree 7 files changed +51
-0
lines changed
doxdox-renderer-bootstrap
doxdox-renderer-github-wiki Expand file tree Collapse file tree 7 files changed +51
-0
lines changed Original file line number Diff line number Diff line change @@ -14,6 +14,12 @@ $ npm install doxdox-cli@v4.0.0-preview.22 doxdox-renderer-bootstrap@v4.0.0-prev
14
14
15
15
## Usage
16
16
17
+ ``` bash
18
+ $ doxdox -r bootstrap > docs.html
19
+ ```
20
+
21
+ or
22
+
17
23
``` bash
18
24
$ doxdox -r bootstrap -o docs.html
19
25
```
Original file line number Diff line number Diff line change @@ -14,6 +14,15 @@ $ npm install doxdox-cli@v4.0.0-preview.22 doxdox-renderer-dash@v4.0.0-preview.2
14
14
15
15
## Usage
16
16
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
+
17
26
``` bash
18
27
$ doxdox -r dash -o docs.zip
19
28
```
Original file line number Diff line number Diff line change @@ -14,6 +14,15 @@ $ npm install doxdox-cli@v4.0.0-preview.22 doxdox-renderer-github-wiki@v4.0.0-pr
14
14
15
15
## Usage
16
16
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
+
17
26
``` bash
18
27
$ doxdox -r github-wiki -o docs.zip
19
28
```
Original file line number Diff line number Diff line change @@ -14,6 +14,12 @@ $ npm install doxdox-cli@v4.0.0-preview.22 doxdox-renderer-json@v4.0.0-preview.2
14
14
15
15
## Usage
16
16
17
+ ``` bash
18
+ $ doxdox -r json > docs.json
19
+ ```
20
+
21
+ or
22
+
17
23
``` bash
18
24
$ doxdox -r json -o docs.json
19
25
```
Original file line number Diff line number Diff line change @@ -14,6 +14,12 @@ $ npm install doxdox-cli@v4.0.0-preview.22 doxdox-renderer-markdown@v4.0.0-previ
14
14
15
15
## Usage
16
16
17
+ ``` bash
18
+ $ doxdox -r markdown > docs.md
19
+ ```
20
+
21
+ or
22
+
17
23
``` bash
18
24
$ doxdox -r markdown -o docs.md
19
25
```
Original file line number Diff line number Diff line change @@ -14,6 +14,15 @@ $ npm install doxdox-cli@v4.0.0-preview.22 doxdox-renderer-pdf@v4.0.0-preview.22
14
14
15
15
## Usage
16
16
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
+
17
26
``` bash
18
27
$ doxdox -r pdf -o docs.pdf
19
28
```
Original file line number Diff line number Diff line change @@ -14,6 +14,12 @@ $ npm install doxdox-cli@v4.0.0-preview.22 doxdox-renderer-template@v4.0.0-previ
14
14
15
15
## Usage
16
16
17
+ ``` bash
18
+ $ doxdox -r template > docs.txt
19
+ ```
20
+
21
+ or
22
+
17
23
``` bash
18
24
$ doxdox -r template -o docs.txt
19
25
```
You can’t perform that action at this time.
0 commit comments