Initail

Author: rstacruz

.gitignore

@@ -0,0 +1 @@
+node_modules/

bin/bookdown

@@ -0,0 +1,79 @@
+#!/usr/bin/env node
+const Metalsmith = require('metalsmith')
+const each = require('lodash/collection/each')
+const marked = require('marked')
+
+var app = bookdown(process.cwd())
+app.build((err) => {
+  if (err) throw err
+})
+
+function bookdown (cwd) {
+  return Metalsmith(cwd)
+    .source('.')
+    .destination('_bookdown')
+    .ignore('**/*.!(md)') // ignore non-md files
+    .ignore('.*') // ignore dot directories
+    .ignore('node_modules')
+    .ignore('_bookdown') // ignore output
+    .ignore('_book')
+    .use(bookdownParse)
+}
+
+function bookdownParse (files, ms, done) {
+  var sources = Object.keys(files)
+  console.log(sources)
+
+  // 1: find or infer the TOC.
+  //    - strip out docs/ prefix
+  //    - turn the first page in the toc to `index.html`
+  //    - turn README to index
+  //    - flatten it as `pages`
+  var toc = {
+    sections: {
+      'index.html': {
+        source: 'README.md'
+      },
+      'docs.html': {
+        source: 'docs/docs.md',
+        sections: {
+          'rails.html': {
+            source: 'docs/rails.md'
+          }
+        }
+      },
+    }
+  }
+
+  files['toc.json'] = {
+    contents: JSON.stringify(toc) + '\n'
+  }
+
+  // 2: flatten TOC to pages.
+  var pages = {
+    'index.html': { source: 'README.md' },
+    'rails.html': { source: 'docs/rails.md' }
+  }
+
+  files['pages.json'] = {
+    contents: JSON.stringify(pages) + '\n'
+  }
+
+
+  // 3: render each page
+  each(pages, (opts, fname) => {
+    const file = files[opts.source]
+    file.markdown = file.contents
+    file.contents = marked(file.contents.toString(), { gfm: true, tables: true })
+    files[fname] = file
+  })
+
+  // 4: add assets
+
+  // delete sources
+  sources.forEach((fname) => {
+    delete files[fname]
+  })
+
+  done()
+}

index.js

@@ -0,0 +1,37 @@
+var marked = require('marked')
+var slugify = require('slugify')
+
+module.exports = function tocify (md) {
+  var tokens = marked.lexer(md)
+
+  var re = { sections: {} }
+  var crumbs = [scope]
+  var current = re
+  var scope
+
+  tokens.forEach((token) => {
+    switch (token.type) {
+      case 'list_start':
+        scope = current.sections = {}
+        crumbs.push(scope)
+        break
+
+      case 'text':
+        const m = token.text.match(/^\[([^\]]*)\]\((.*)\)$/)
+        const title = m ? m[1] : token.text
+        const source = m ? m[2] : null
+        const key = slugify(title).toLowerCase()
+
+        current = scope[key] = { title: title }
+        if (source) current.source = source
+        break
+
+      case 'list_end':
+        crumbs.pop()
+        scope = crumbs[crumbs.length - 1]
+        break
+    }
+  })
+
+  return re
+}

lib/tocify.js

@@ -0,0 +1,24 @@
+{
+  "name": "bookdown",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "mocha"
+  },
+  "bin": {
+    "bookdown": "bin/bookdown"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "lodash": "3.10.1",
+    "marked": "0.3.5",
+    "metalsmith": "2.1.0",
+    "slugify": "0.1.1"
+  },
+  "devDependencies": {
+    "expect": "1.11.1",
+    "mocha": "2.3.3"
+  }
+}

package.json

@@ -0,0 +1,5 @@
+describe('my project', function () {
+  it('works', function () {
+    expect(2).toEqual(2)
+  })
+})

test/basic_test.js

@@ -0,0 +1 @@
+--require test/setup

test/mocha.opts

@@ -0,0 +1 @@
+global.expect = require('expect')

test/setup.js

@@ -0,0 +1,72 @@
+const tocify = require('../lib/tocify')
+
+describe('tocify', function () {
+  var toc = [
+    '# toc',
+    '',
+    '* [readme](/README.md)',
+  ].join('\n')
+
+  var output
+
+  it('works', function () {
+    output = tocify([
+      '* [Readme](/README.md)',
+    ].join('\n'))
+
+    expect(output).toEqual({
+      sections: {
+        readme: {
+          title: 'Readme',
+          source: '/README.md'
+        }
+      }
+    })
+  })
+
+  it('handles non-links', function () {
+    output = tocify([
+      '* Readme',
+    ].join('\n'))
+
+    expect(output).toEqual({
+      sections: {
+        readme: {
+          title: 'Readme'
+        }
+      }
+    })
+  })
+
+  it('takes care of nesting', function () {
+    output = tocify([
+      '* [Readme](/README.md)',
+      '* Getting Started',
+      '  * [Install](/docs/install.md)',
+      '  * [Usage](/docs/usage.md)'
+    ].join('\n'))
+
+    expect(output).toEqual({
+      sections: {
+        readme: {
+          title: 'Readme',
+          source: '/README.md',
+        },
+        'getting-started': {
+          title: 'Getting Started',
+          sections: {
+            'install': {
+              title: 'Install',
+              source: '/docs/install.md',
+            },
+            'usage': {
+              title: 'Usage',
+              source: '/docs/usage.md',
+            }
+          }
+        }
+      }
+    })
+  })
+
+})

test/tocify_test.js

@@ -0,0 +1,6 @@
+describe('to do', function () {
+  it('parsing toc')
+  it('flattening toc to pages')
+  it('rendering pages')
+})
+