Update API

Author: rstacruz

README.md

@@ -1,4 +1,4 @@
-# bookdown
+# bookdown-core
 
 How it works:
 
@@ -18,5 +18,5 @@ docs/
 
 ## API
 
-* `bookdown-core/compile` - Metalsmith middleware.
-* `bookdown-core` - Metalsmith generator.
+* `bookdown-core` - Metalsmith middleware.
+* `bookdown-core/ms` - Metalsmith instance generator.

compile.js

@@ -1,19 +1,84 @@
-'use strict'
+const ware = require('ware')
+const each = require('lodash/collection/each')
+const marked = require('marked')
 
-const Metalsmith = require('metalsmith')
-const compile = require('./compile')
+const tocify = require('./tocify')
+const indexify = require('./indexify')
+
+module.exports = function (options) {
+  var compile = ware()
+    .use(buildIndex)
+    .use(renderMarkdown)
+
+  return compile.run.bind(compile)
+}
 
 /**
- * Returns a metalsmith object.
+ * Builds toc.json and index.json.
+ *
+ * Each toc item has:
+ *
+ * - `sections` (key/value of sections)
+ * - `source` (path to source)
+ * - `title` (title)
+ * - `url` (URL, if applicable)
+ *
+ * Each index item has:
+ *
+ * - `source`
+ * - `title`
  */
 
-function bookdown (cwd, options) {
-  return Metalsmith(cwd)
-    .source('.')
-    .destination('_bookdown')
-    .ignore('!{*.md,docs}') // only include /docs/ and /*.md
-    .ignore('_bookdown') // ignore output
-    .use(compile(options))
+function buildIndex (files, ms, done) {
+  if (!files['docs/README.md']) {
+    var err = new Error('No table of contents found')
+    return done(err)
+  }
+
+  var toc = tocify(files['docs/README.md'].contents.toString())
+  var index = indexify(toc)
+
+  files['toc.json'] = { contents: JSON.stringify(toc, null, 2) + '\n' }
+  files['index.json'] = { contents: JSON.stringify(index, null, 2) + '\n' }
+
+  done()
 }
 
-module.exports = bookdown
+/**
+ * Converts .md to .html.
+ *
+ * At the end of this, you get a site with `.html` files (bare, no layout)
+ * and a `toc.json` and `index.json`.
+ *
+ * Each html also has:
+ *
+ * - `title` (title according to TOC)
+ * - `source` (path of source)
+ * - `markdown` (raw Markdown source)
+ * - `html` (rendered HTML)
+ */
+
+function renderMarkdown (files, ms, done) {
+  var sources = Object.keys(files)
+  var pages = JSON.parse(files['index.json'].contents)
+
+  // 3: render each page
+  each(pages, (opts, fname) => {
+    const file = files[opts.source]
+    file.markdown = file.contents
+    file.html = marked(file.markdown.toString(), { gfm: true, tables: true })
+    file.title = opts.title
+    file.source = opts.source
+    file.contents = file.html
+    files[fname] = file
+  })
+
+  // delete sources
+  sources.forEach((fname) => {
+    if (fname !== 'toc.json' && fname !== 'index.json') {
+      delete files[fname]
+    }
+  })
+
+  done()
+}

lib/compile.js

@@ -0,0 +1,19 @@
+'use strict'
+
+const Metalsmith = require('metalsmith')
+const compile = require('./compile')
+
+/**
+ * Returns a metalsmith object.
+ */
+
+function bookdown (cwd, options) {
+  return Metalsmith(cwd)
+    .source('.')
+    .destination('_bookdown')
+    .ignore('!{*.md,docs}') // only include /docs/ and /*.md
+    .ignore('_bookdown') // ignore output
+    .use(compile(options))
+}
+
+module.exports = bookdown

lib/index.js

@@ -0,0 +1 @@
+module.exports = require('./lib/ms')

lib/ms.js

@@ -6,8 +6,8 @@
   "scripts": {
     "test": "mocha"
   },
-  "author": "",
-  "license": "ISC",
+  "author": "Rico Sta. Cruz <rico@ricostacruz.com>",
+  "license": "MIT",
   "dependencies": {
     "lodash": "3.10.1",
     "marked": "0.3.5",

ms.js

@@ -1,4 +1,4 @@
-const compile = require('../lib/compile')()
+const compile = require('../index')()
 
 describe('compile', function () {
   beforeEach(function (done) {