Merge f6f13ac into 0c48454

.travis.yml

@@ -3,7 +3,7 @@ os:
   - windows
   - linux
 node_js:
-  - 'stable'
+  - 'node'
   - '10'
   - '8'
 cache:

lib/fix_html.js

@@ -5,6 +5,7 @@ const slugify = require('slugify')
 const resolve = require('path').resolve
 const dirname = require('path').dirname
 const relative = require('path').relative
+const normalizePath = require('./helpers/normalize_path')
 
 /**
  * Internal: Performs in-place HTML filters (such as fixing URLs).
@@ -33,7 +34,7 @@ function idify ($) {
  */
 
 function fixReferences ($, fname, sources, files, page) {
-  var base = page.source
+  var base = normalizePath(page.source)
   var m
 
   $('[href], [src]').each(function () {
@@ -57,11 +58,12 @@ function fixReferences ($, fname, sources, files, page) {
     }
 
     // Get the target source file it points to (eg, `docs/usage.md`).
-    var target = getTarget(origUrl, base)
+    var target = normalizePath(getTarget(origUrl, base))
 
     // Ensure that it's available.
     if (!sources[target]) {
-      throw new Error(`${base}: Unknown reference '${origUrl}'`)
+      console.log(sources)
+      throw new Error(`${base}: Unknown reference '${origUrl}' (target: ${target})`)
     }
 
     // Relativize that absolute URL.

lib/helpers/normalize_path.js

@@ -0,0 +1,9 @@
+module.exports = function fixSlashes (url) {
+  if (!url) {
+    return url
+  }
+  url = url.replace(/\\\\/g, '/')
+    .replace(/\\/g, '/')
+
+  return url
+}

lib/index.js

@@ -224,6 +224,7 @@ function renderMarkdown (files, ms, done) {
 
   // render each page
   each(pages, (page, fname) => {
+    // console.log(files)
     const file = externalSource(page.source) ? { contents: '' } : files[page.source]
 
     const contents = file.contents.toString()

lib/indexify.js

@@ -1,3 +1,5 @@
+const normalizePath = require('./helpers/normalize_path')
+
 /**
  * Turns a TOC into an index.
  *
@@ -15,8 +17,9 @@ module.exports = function indexify (toc) {
 
   function walk (item, rootTitle) {
     if (item.url) {
-      sources[item.source] = item.url
-      index[item.url] = {
+      const url = normalizePath(item.url)
+      sources[item.source] = url
+      index[url] = {
         source: item.source,
         title: rootTitle !== item.title ? `${item.title} - ${rootTitle}` : item.title,
         pageTitle: item.title,

lib/tocify.js

@@ -4,8 +4,10 @@
 const marked = require('marked')
 const normalize = require('path').normalize
 const stripMarkdown = require('./helpers/strip_markdown')
+const normalizePath = require('./helpers/normalize_path')
 const assign = Object.assign
 
+const log = require('./log')
 const slugify = require('./slugify')
 const tocifyPage = require('./tocify_page')
 const externalSource = require('./external_source')
@@ -91,6 +93,8 @@ class Tocify {
       }
     })
 
+    log(`tocify(run): sources ${JSON.stringify(this.sources)}`)
+
     return re
   }
 
@@ -137,6 +141,9 @@ class Tocify {
     // `source`: Takes care of relative (../) paths
     assign(item, absolutify(item.source, this.docs))
 
+    // `source`: Handle OS specific paths
+    assign(item, pathify(item.source))
+
     if (this.sources[item.source]) {
       // If this same item exists before, reuse its URL and stuff
       const previous = this.sources[item.source]
@@ -158,6 +165,8 @@ class Tocify {
       if (headings) item.headings = headings
     }
 
+    log(`tocify(itemify): item ${JSON.stringify(item)}`)
+
     return item
   }
 
@@ -227,3 +236,19 @@ function absolutify (source, root) {
   source = source.replace(/^\//, '')
   return { source }
 }
+
+/*
+ * Internal: takes care of OS specific paths.
+ *
+ *     pathify("..\README.md", "docs") => "../README.md"
+ *     pathify("\README.md", "docs")   => "/README.md"
+ */
+
+function pathify (source) {
+  if (externalSource(source)) {
+    return { source }
+  }
+
+  source = normalizePath(source)
+  return { source }
+}

test/index/invalid_refs_test.js

@@ -26,6 +26,6 @@ describe('index/invalid refs:', function () {
   it('catches invalid references', function () {
     expect(this.err).toBeDefined()
     expect(this.err.message).toEqual(
-      "README.md: Unknown reference 'docs/getting-started.md'")
+      "README.md: Unknown reference 'docs/getting-started.md' (target: docs/getting-started.md)")
   })
 })