UNPKG

doxdox-renderer-github-wiki

Version:

GitHub Wiki renderer for doxdox.

github.com/docsbydoxdox/doxdox

docsbydoxdox/doxdox

29 lines (19 loc) • 846 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# doxdox-renderer-github-wiki > GitHub Wiki renderer for doxdox. [![NPM version](https://img.shields.io/npm/v/doxdox-renderer-github-wiki?style=flat-square)](https://www.npmjs.org/package/doxdox-renderer-github-wiki) [![NPM downloads per month](https://img.shields.io/npm/dm/doxdox-renderer-github-wiki?style=flat-square)](https://www.npmjs.org/package/doxdox-renderer-github-wiki) [![doxdox documentation](https://img.shields.io/badge/doxdox-documentation-%23E85E95?style=flat-square)](https://doxdox.org) ## Install ```bash $ npm install doxdox-cli@v4.0.0-preview.25 doxdox-renderer-github-wiki@v4.0.0-preview.25 --save-dev ``` ## Usage > [!WARNING] > The `-o`/`--output` flag is required when using this renderer on Windows PowerShell. ```bash $ doxdox -r github-wiki > docs.zip ``` or ```bash $ doxdox -r github-wiki -o docs.zip ```