File tree Expand file tree Collapse file tree 6 files changed +594
-6
lines changed Expand file tree Collapse file tree 6 files changed +594
-6
lines changed Original file line number Diff line number Diff line change @@ -2,4 +2,5 @@ __coverage__
2
2
.build-info
3
3
.sass-cache
4
4
dist
5
- node_modules
5
+ node_modules
6
+ _auto_doc_
Original file line number Diff line number Diff line change
1
+ #!/usr/bin/env node
2
+
3
+ /**
4
+ * POC doc generation script.
5
+ */
6
+
7
+ /* eslint-disable import/no-extraneous-dependencies, no-console */
8
+
9
+ const fs = require ( 'fs' ) ;
10
+ const jsdoc2md = require ( 'jsdoc-to-markdown' ) ;
11
+ const mkpath = require ( 'mkpath' ) ;
12
+ const path = require ( 'path' ) ;
13
+
14
+ const outputDir = path . resolve ( __dirname , '../_auto_doc_' ) ;
15
+
16
+ const data = jsdoc2md . getTemplateDataSync ( { files : 'src/**/*.js' } ) ;
17
+
18
+ const moduleNames = data . reduce ( ( res , obj ) => {
19
+ if ( obj . kind === 'module' ) res . push ( obj . name ) ;
20
+ return res ;
21
+ } , [ ] ) ;
22
+
23
+ moduleNames . forEach ( ( name ) => {
24
+ const template = `{{#module name="${ name } "}}{{>docs}}{{/module}}` ;
25
+ console . log ( `rendering ${ name } , template: ${ template } ` ) ;
26
+ const output = jsdoc2md . renderSync ( { data, template } ) ;
27
+ const destFile = `${ outputDir } /${ name } .md` ;
28
+ mkpath . sync ( path . dirname ( destFile ) ) ;
29
+ fs . writeFileSync ( destFile , output ) ;
30
+ } ) ;
You can’t perform that action at this time.
0 commit comments