File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -265,6 +265,13 @@ See below for <a href="#ex-yui3">more</a> <a href="#ex-yuidoc">examples</a>.
265265 See the <a href =" https://markdown-it.github.io/markdown-it/#MarkdownIt.new" >markdown-it API</a > for details.
266266 </td >
267267</tr >
268+ <tr >
269+ <td >`preprocessor`</td >
270+ <td >
271+ Specifies the array of your preprocessor script or npm package like `yuidoc-preprocessor-foo`
272+ that implements a preprocessor. See the <a href =" #ex-preprocessor" >example used preprocessor</a >.
273+ </td >
274+ </tr >
268275</table >
269276
270277<h3 id =" ex-yui3" >Example: YUI 3 Library API </h3 >
@@ -315,3 +322,18 @@ project:
315322 }
316323}
317324```
325+
326+ <h3 id =" ex-preprocessor" >Example: Using preprocessor</h3 >
327+
328+ <p >This sample `yuidoc.json` file used preprocessor option:</p >
329+
330+ ```
331+ {
332+ " name" : " My Project" ,
333+ " version" : " 1.0.0" ,
334+ " options" : {
335+ " paths" : " src" ,
336+ " preprocessor" : [" ./path/to/custom_doc_preprocessor.js" , " yuidoc-preprocessor-foo" ]
337+ }
338+ }
339+ ```
You can’t perform that action at this time.
0 commit comments