You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**doxdox** is a simple to use documentation generator that takes JSDoc comment blocks and generates different documentation formats; Markdown, Bootstrap, and custom Handlebars templates.
14
+
15
+
**doxdox** also features support for extendability via custom plugins for both parsing and generating documentation.
16
+
17
+
**In**
18
+
19
+
```javascript
20
+
/**
21
+
* Parse array of directory globs and/or files, and then render the parsed data through the defined layout plugin.
* @param{Array}inputs Array of directory globs and/or files.
26
+
* @param{Object}config Configuration object.
27
+
* @param{String}config.ignore Array of paths to ignore.
28
+
* @param{String}config.parser String representing the parser to be used.
29
+
* @param{String}config.layout String representing the layout plugin to be used.
30
+
* @return{Object} Promise
31
+
* @public
32
+
*/
33
+
```
34
+
35
+
**Out**
36
+
37
+

38
+
39
+
_Bootstrap template plugin_
40
+
41
+
## Getting Started
42
+
43
+
The following instructions assume you have already setup JSDoc comment blocks in your codebase. If you have not and would like to learn more about how to use JSDoc, visit <http://usejsdoc.org/>.
44
+
45
+
First install <b>doxdox</b> globally with NPM.
14
46
15
47
```bash
16
48
$ npm install doxdox -g
17
49
```
18
50
19
-
## Usage
20
-
21
-
### NPM Run Scripts
51
+
Then, once you have **doxdox** installed globally (or local to your project, see below), you can start generating documentation. For this example, we will be generating a Markdown file and storing it within the project.
22
52
23
-
For more information on NPM run scripts visit <https://docs.npmjs.com/cli/run-script>.
53
+
With a directory structure similar to the example shown below, run the following command to generate a Markdown file and output the generated contents to a new file named `DOCUMENTATION.md`.
0 commit comments