Skip to content

Commit 2b2e078

Browse files
committed
Changed screenshot in README.md
1 parent 4c4029f commit 2b2e078

File tree

4 files changed

+14
-6
lines changed

4 files changed

+14
-6
lines changed

.npmignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ test/
88

99
Makefile
1010

11-
screenshot.png
11+
screenshot.jpg

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
[![NPM Version](http://img.shields.io/npm/v/doxdox.svg?style=flat)](https://www.npmjs.org/package/doxdox)
1111
[![Latest Documentation](https://doxdox.org/images/badge-flat.svg)](https://doxdox.org/neogeek/doxdox)
1212

13-
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.
1414

1515
doxdox also features support for extendability via custom plugins for both parsing and generating documentation.
1616

@@ -34,9 +34,9 @@ doxdox also features support for extendability via custom plugins for both parsi
3434

3535
**Out**
3636

37-
![screenshot](screenshot.png)
37+
![screenshot](screenshot.jpg)
3838

39-
_Bootstrap template plugin_
39+
_Bootstrap template plugin_ <https://github.com/neogeek/doxdox-plugin-bootstrap>
4040

4141
## Getting Started
4242

@@ -48,9 +48,9 @@ First install <b>doxdox</b> globally with NPM.
4848
$ npm install doxdox -g
4949
```
5050

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.
5252

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).
5454

5555
```bash
5656
$ doxdox 'lib/**/*.js' --layout markdown --output DOCUMENTATION.md
@@ -210,6 +210,14 @@ See [documentation](DOCUMENTATION.md) for more information on [`parseInputs`](DO
210210
- [`doxdox-plugin-github-wiki`](https://github.com/neogeek/doxdox-plugin-github-wiki) - 🔌 GitHub wiki export plugin for doxdox.
211211
- [`grunt-doxdox`](https://github.com/neogeek/grunt-doxdox) - Grunt plugin for doxdox.
212212

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.
220+
213221
## License
214222

215223
[MIT](LICENSE)

screenshot.jpg

885 KB
Loading

screenshot.png

-203 KB
Binary file not shown.

0 commit comments

Comments
 (0)