build-documentation.js 866 B

123456789101112131415161718192021222324252627
  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', 'Utils', 'Translator', 'Plugin']
  8. documentation('../src/index.js', {order: docOrder}, function (err, comments) {
  9. if (err) {
  10. throw new Error(err)
  11. }
  12. documentationFormatter(comments, {}, function (err, output) {
  13. if (err) {
  14. throw new Error(err)
  15. }
  16. var inputMarkdownContent = remark.parse(fs.readFileSync('src/api/docs.md', 'utf-8'))
  17. var newStuff = remark.parse(output)
  18. inject('Uppy Core & Plugins', inputMarkdownContent, newStuff)
  19. fs.writeFileSync('src/api/docs.md', remark.stringify(inputMarkdownContent))
  20. console.info(chalk.green('✓ documentation generated'))
  21. })
  22. })