summaryrefslogtreecommitdiffstats
path: root/packages/gitbook-html/lib/readme.js
diff options
context:
space:
mode:
authorSamy Pessé <samypesse@gmail.com>2016-05-02 16:12:07 +0200
committerSamy Pessé <samypesse@gmail.com>2016-12-22 12:32:17 +0100
commitc3a417a9834ba3c25ceb20a3cb650fa0384c60d0 (patch)
treebdbffac34a15636265e834b9bf0c484054426135 /packages/gitbook-html/lib/readme.js
parent9e88003d7373e2e7efac862494a9a0db4847f617 (diff)
downloadgitbook-c3a417a9834ba3c25ceb20a3cb650fa0384c60d0.zip
gitbook-c3a417a9834ba3c25ceb20a3cb650fa0384c60d0.tar.gz
gitbook-c3a417a9834ba3c25ceb20a3cb650fa0384c60d0.tar.bz2
Adapt for gitbook v3
Diffstat (limited to 'packages/gitbook-html/lib/readme.js')
-rwxr-xr-xpackages/gitbook-html/lib/readme.js7
1 files changed, 6 insertions, 1 deletions
diff --git a/packages/gitbook-html/lib/readme.js b/packages/gitbook-html/lib/readme.js
index 0d179ad..34e447e 100755
--- a/packages/gitbook-html/lib/readme.js
+++ b/packages/gitbook-html/lib/readme.js
@@ -1,7 +1,12 @@
var _ = require('lodash');
var dom = require('./dom');
-// HTML -> Readme
+/**
+ Parse an HTML content into metadata about a readme
+
+ @param {String} html
+ @return {Object}
+*/
function parseReadme(html) {
var $ = dom.parse(html);