@@ -95,28 +95,28 @@ _Markdown_
95
95
For more information on Markdown visit < http://daringfireball.net/projects/markdown/ > .
96
96
97
97
``` bash
98
- $ doxdox ' src /**/*.js' --layout markdown --output DOCUMENTATION.md
98
+ $ doxdox ' lib /**/*.js' --layout markdown --output DOCUMENTATION.md
99
99
```
100
100
101
101
_ Bootstrap_
102
102
103
103
Form more information on Bootstrap visit < https://v4-alpha.getbootstrap.com/ > .
104
104
105
105
``` bash
106
- $ doxdox ' src /**/*.js' --layout bootstrap --output docs/index.html
106
+ $ doxdox ' lib /**/*.js' --layout bootstrap --output docs/index.html
107
107
```
108
108
109
109
_ Custom Handlebars Template_
110
110
111
111
For more information on writing Handlebars templates visit < http://handlebarsjs.com/ > .
112
112
113
113
``` bash
114
- $ doxdox ' src /**/*.js' --layout templates/README.hbs --output README.md
114
+ $ doxdox ' lib /**/*.js' --layout templates/README.hbs --output README.md
115
115
```
116
116
117
117
#### Ignore
118
118
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 .
120
120
121
121
``` bash
122
122
$ doxdox ' ./**/*.js' --ignore ' ./coverage/**/*.js'
@@ -161,7 +161,7 @@ $ npm install doxdox --save-dev
161
161
"doxdox" : " 2.0.1"
162
162
},
163
163
"scripts" : {
164
- "docs" : " doxdox 'src /**/*.js' --layout markdown --output DOCUMENTATION.md"
164
+ "docs" : " doxdox 'lib /**/*.js' --layout markdown --output DOCUMENTATION.md"
165
165
}
166
166
}
167
167
```
@@ -175,7 +175,7 @@ $ npm run docs
175
175
``` javascript
176
176
const doxdox = require (' doxdox' );
177
177
178
- parseInputs ([' src /**/*.js' ], {
178
+ parseInputs ([' lib /**/*.js' ], {
179
179
' parser' : ' dox' ,
180
180
' layout' : ' markdown'
181
181
}).then (content => {
@@ -191,6 +191,8 @@ See [documentation](DOCUMENTATION.md) for more information on [`parseInputs`](DO
191
191
192
192
### Core Packages
193
193
194
+ All core packages come pre-installed with doxdox.
195
+
194
196
| Package | Version | Dependencies | Documentation |
195
197
| ------- | ------- | ------------ | ------------- |
196
198
| [ ` 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
205
207
206
208
### Other Packages
207
209
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
+
208
218
| Package | Version | Dependencies | Documentation |
209
219
| ------- | ------- | ------------ | ------------- |
210
220
| [ ` 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