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.
13
+
doxdox is a simple to use documentation generator that takes JSDoc comment blocks and generates different documentation formats; [Markdown](http://daringfireball.net/projects/markdown/), [Bootstrap](https://v4-alpha.getbootstrap.com/), and custom [Handlebars](http://handlebarsjs.com/>) templates.
14
14
15
15
doxdox also features support for extendability via custom plugins for both parsing and generating documentation.
16
16
@@ -34,9 +34,9 @@ doxdox also features support for extendability via custom plugins for both parsi
@@ -48,9 +48,9 @@ First install <b>doxdox</b> globally with NPM.
48
48
$ npm install doxdox -g
49
49
```
50
50
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.
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](http://daringfireball.net/projects/markdown/) file and storing it within the project.
52
52
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`.
53
+
With a directory structure similar to the example shown below, run the following command to generate a [Markdown](http://daringfireball.net/projects/markdown/) file and output the generated contents to a new file named [`DOCUMENTATION.md`](DOCUMENTATION.md).
@@ -210,6 +210,14 @@ See [documentation](DOCUMENTATION.md) for more information on [`parseInputs`](DO
210
210
-[`doxdox-plugin-github-wiki`](https://github.com/neogeek/doxdox-plugin-github-wiki) - 🔌 GitHub wiki export plugin for doxdox.
211
211
-[`grunt-doxdox`](https://github.com/neogeek/grunt-doxdox) - Grunt plugin for doxdox.
212
212
213
+
## Questions
214
+
215
+
If you have any questions regarding the use of doxdox, please use either the [Gitter](https://gitter.im/neogeek/doxdox) chat room or [Stack Overflow](http://stackoverflow.com/questions/ask?tags=doxdox). The issue tracker is to be used for bug reports and feature requests only.
216
+
217
+
## Contributing
218
+
219
+
Be sure to review the [Contributing Guidelines](CONTRIBUTING.md) before logging an issue or making a pull request.
0 commit comments