Skip to content

Commit ac5c712

Browse files
committed
Updated README.md
1 parent a3d109e commit ac5c712

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,28 +95,28 @@ _Markdown_
9595
For more information on Markdown visit <http://daringfireball.net/projects/markdown/>.
9696

9797
```bash
98-
$ doxdox 'src/**/*.js' --layout markdown --output DOCUMENTATION.md
98+
$ doxdox 'lib/**/*.js' --layout markdown --output DOCUMENTATION.md
9999
```
100100

101101
_Bootstrap_
102102

103103
Form more information on Bootstrap visit <https://v4-alpha.getbootstrap.com/>.
104104

105105
```bash
106-
$ doxdox 'src/**/*.js' --layout bootstrap --output docs/index.html
106+
$ doxdox 'lib/**/*.js' --layout bootstrap --output docs/index.html
107107
```
108108

109109
_Custom Handlebars Template_
110110

111111
For more information on writing Handlebars templates visit <http://handlebarsjs.com/>.
112112

113113
```bash
114-
$ doxdox 'src/**/*.js' --layout templates/README.hbs --output README.md
114+
$ doxdox 'lib/**/*.js' --layout templates/README.hbs --output README.md
115115
```
116116

117117
#### Ignore
118118

119-
The ignore flag allows you to ignore both directories (with glob syntax) and files. Comma separated value.
119+
The ignore flag allows you to ignore both directories (with glob syntax) and files. Comma separated values.
120120

121121
```bash
122122
$ doxdox './**/*.js' --ignore './coverage/**/*.js'
@@ -161,7 +161,7 @@ $ npm install doxdox --save-dev
161161
"doxdox": "2.0.1"
162162
},
163163
"scripts": {
164-
"docs": "doxdox 'src/**/*.js' --layout markdown --output DOCUMENTATION.md"
164+
"docs": "doxdox 'lib/**/*.js' --layout markdown --output DOCUMENTATION.md"
165165
}
166166
}
167167
```
@@ -175,7 +175,7 @@ $ npm run docs
175175
```javascript
176176
const doxdox = require('doxdox');
177177

178-
parseInputs(['src/**/*.js'], {
178+
parseInputs(['lib/**/*.js'], {
179179
'parser': 'dox',
180180
'layout': 'markdown'
181181
}).then(content => {
@@ -191,6 +191,8 @@ See [documentation](DOCUMENTATION.md) for more information on [`parseInputs`](DO
191191

192192
### Core Packages
193193

194+
All core packages come pre-installed with doxdox.
195+
194196
| Package | Version | Dependencies | Documentation |
195197
| ------- | ------- | ------------ | ------------- |
196198
| [`doxdox-parser-dox`](https://github.com/neogeek/doxdox-parser-dox) | [![NPM Version](http://img.shields.io/npm/v/doxdox-parser-dox.svg?style=flat)](https://www.npmjs.org/package/doxdox-parser-dox) | [![dependencies Status](https://david-dm.org/neogeek/doxdox-parser-dox/status.svg)](https://david-dm.org/neogeek/doxdox-parser-dox) | [![Latest Documentation](https://doxdox.org/images/badge-flat.svg)](https://doxdox.org/neogeek/doxdox-parser-dox) |
@@ -205,6 +207,14 @@ See [documentation](DOCUMENTATION.md) for more information on [`parseInputs`](DO
205207

206208
### Other Packages
207209

210+
Non-core packages must be installed separately from doxdox.
211+
212+
```bash
213+
$ npm install doxdox doxdox-plugin-dash --save-dev
214+
```
215+
216+
The, via the `--layout` flag, you specify the plugin name minus the `doxdox-plugin-`
217+
208218
| Package | Version | Dependencies | Documentation |
209219
| ------- | ------- | ------------ | ------------- |
210220
| [`doxdox-plugin-dash`](https://github.com/neogeek/doxdox-plugin-dash) | [![NPM Version](http://img.shields.io/npm/v/doxdox-plugin-dash.svg?style=flat)](https://www.npmjs.org/package/doxdox-plugin-dash) | [![dependencies Status](https://david-dm.org/neogeek/doxdox-plugin-dash/status.svg)](https://david-dm.org/neogeek/doxdox-plugin-dash) | [![Latest Documentation](https://doxdox.org/images/badge-flat.svg)](https://doxdox.org/neogeek/doxdox-plugin-dash) |

0 commit comments

Comments
 (0)