Selaa lähdekoodia

Improved docs generator

Artur Paikin 9 vuotta sitten
vanhempi
commit
72558280f2
2 muutettua tiedostoa jossa 27 lisäystä ja 20 poistoa
  1. 26 19
      website/documentation.js
  2. 1 1
      website/package.json

+ 26 - 19
website/documentation.js

@@ -1,26 +1,33 @@
 var documentation = require('documentation');
 var documentation = require('documentation');
 var documentationFormatter = documentation.formats['md'];
 var documentationFormatter = documentation.formats['md'];
+var remark = require('remark');
+var inject = require('mdast-util-inject');
+var chalk = require('chalk');
 var fs = require('fs');
 var fs = require('fs');
 
 
-var docsFrontmatter = '---\ntype: api\norder: 1\ntitle: "Generated API Docs"\n---\n';
+documentation('../src/index.js', {}, function (err, comments) {
+  if (err) console.log(err);
 
 
-// documentation('../src/index.js', {}, function (err, comments) {
-//   documentationFormatter(comments, {}, function (err, output) {
-//     var docsWithFrontmatter = docsFrontmatter + output;
-//     // console.log(docsWithFrontmatter);
-//     fs.writeFileSync('src/api/docs.md', docsWithFrontmatter);
-//     console.log('documentation generated');
-//   });
-// });
+  documentationFormatter(comments, {}, function (err, output) {
+    if (err) console.log(err);
 
 
-var remark = require('remark');
-var inputMarkdownContent = fs.readFileSync('src/api/docs.md', 'utf-8');
-var docjsReadme = require('documentation-readme/lib/plugin');
-remark().use(docjsReadme, {
- section: 'Uppy Core & Plugins', // inject into the ## Usage section of the input doc
- documentationArgs: [ '../src/index.js' ]
-}).process(inputMarkdownContent, function (err, vfile, content) {
-fs.writeFileSync('src/api/docs.md', content);
- // console.log(content);
- console.log('documentation generated');
+    var inputMarkdownContent = remark.parse(fs.readFileSync('src/api/docs.md', 'utf-8'));
+    var newStuff = remark.parse(output);
+    inject('Uppy Core & Plugins', inputMarkdownContent, newStuff);
+
+    fs.writeFileSync('src/api/docs.md', remark.stringify(inputMarkdownContent));
+    console.info(chalk.green('✓ documentation generated'));
+  });
 });
 });
+
+// var remark = require('remark');
+// var inputMarkdownContent = fs.readFileSync('src/api/docs.md', 'utf-8');
+// var docjsReadme = require('documentation-readme/lib/plugin');
+// remark().use(docjsReadme, {
+//  section: 'Uppy Core & Plugins', // inject into the ## Usage section of the input doc
+//  documentationArgs: [ '../src/index.js' ]
+// }).process(inputMarkdownContent, function (err, vfile, content) {
+// fs.writeFileSync('src/api/docs.md', content);
+//  // console.log(content);
+//  console.log('documentation generated');
+// });

+ 1 - 1
website/package.json

@@ -30,8 +30,8 @@
     "browserify": "^12.0.1",
     "browserify": "^12.0.1",
     "chalk": "^1.1.1",
     "chalk": "^1.1.1",
     "documentation": "^3.0.4",
     "documentation": "^3.0.4",
-    "documentation-readme": "^2.1.1",
     "glob": "^6.0.1",
     "glob": "^6.0.1",
+    "mdast-util-inject": "^1.1.0",
     "multi-glob": "^1.0.1",
     "multi-glob": "^1.0.1",
     "node-notifier": "^4.4.0",
     "node-notifier": "^4.4.0",
     "remark": "^3.0.0",
     "remark": "^3.0.0",