documentation.js 1.3 KB

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