summaryrefslogtreecommitdiffstats
path: root/lib/parse
diff options
context:
space:
mode:
Diffstat (limited to 'lib/parse')
-rw-r--r--lib/parse/index.js1
-rw-r--r--lib/parse/readme.js32
2 files changed, 33 insertions, 0 deletions
diff --git a/lib/parse/index.js b/lib/parse/index.js
index 0e333e4..0ebb03a 100644
--- a/lib/parse/index.js
+++ b/lib/parse/index.js
@@ -5,4 +5,5 @@ module.exports = {
lex: require('./lex'),
progress: require('./progress'),
navigation: require('./navigation'),
+ readme: require('./readme')
};
diff --git a/lib/parse/readme.js b/lib/parse/readme.js
new file mode 100644
index 0000000..aab094d
--- /dev/null
+++ b/lib/parse/readme.js
@@ -0,0 +1,32 @@
+var _ = require('lodash');
+var marked = require('marked');
+
+function extractFirstNode(nodes, nType) {
+ return _.chain(nodes)
+ .filter(function(node) {
+ return node.type == nType;
+ })
+ .pluck("text")
+ .first()
+ .value();
+}
+
+
+function parseReadme(src) {
+ var nodes, title, description;
+
+ // Parse content
+ nodes = marked.lexer(src);
+
+ var title = extractFirstNode(nodes, "heading");
+ var description = extractFirstNode(nodes, "paragraph");
+
+ return {
+ title: title,
+ description: description
+ };
+}
+
+
+// Exports
+module.exports = parseReadme;