documentation.js 1.3 KB

1234567891011121314151617181920212223242526272829303132333435
  1. var documentation = require('documentation');
  2. var documentationFormatter = documentation.formats['md'];
  3. var remark = require('remark');
  4. var inject = require('mdast-util-inject');
  5. var chalk = require('chalk');
  6. var fs = require('fs');
  7. var docOrder = ['Core'];
  8. documentation('../src/index.js', {order: docOrder}, function (err, comments) {
  9. if (err) console.log(err);
  10. documentationFormatter(comments, {}, function (err, output) {
  11. if (err) console.log(err);
  12. var inputMarkdownContent = remark.parse(fs.readFileSync('src/api/docs.md', 'utf-8'));
  13. var newStuff = remark.parse(output);
  14. inject('Uppy Core & Plugins', inputMarkdownContent, newStuff);
  15. fs.writeFileSync('src/api/docs.md', remark.stringify(inputMarkdownContent));
  16. console.info(chalk.green('✓ documentation generated'));
  17. });
  18. });
  19. // var remark = require('remark');
  20. // var inputMarkdownContent = fs.readFileSync('src/api/docs.md', 'utf-8');
  21. // var docjsReadme = require('documentation-readme/lib/plugin');
  22. // remark().use(docjsReadme, {
  23. // section: 'Uppy Core & Plugins', // inject into the ## Usage section of the input doc
  24. // documentationArgs: [ '../src/index.js' ]
  25. // }).process(inputMarkdownContent, function (err, vfile, content) {
  26. // fs.writeFileSync('src/api/docs.md', content);
  27. // // console.log(content);
  28. // console.log('documentation generated');
  29. // });