Skip to content

Commit dc9f791

Browse files
committed
Updated README.md
1 parent e43c188 commit dc9f791

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
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, Bootstrap, and custom Handlebars templates.
1414

15-
**doxdox** also features support for extendability via custom plugins for both parsing and generating documentation.
15+
doxdox also features support for extendability via custom plugins for both parsing and generating documentation.
1616

1717
**In**
1818

@@ -48,7 +48,7 @@ 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 file and storing it within the project.
5252

5353
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`.
5454

@@ -69,7 +69,7 @@ $ doxdox 'lib/**/*.js' --layout markdown --output DOCUMENTATION.md
6969

7070
## Installation
7171

72-
**doxdox** can be installed via either NPM or Yarn.
72+
doxdox can be installed via either NPM or Yarn.
7373

7474
```bash
7575
$ npm install doxdox -g

0 commit comments

Comments
 (0)