Set the first page as the home page

Author: rstacruz

HISTORY.md

@@ -1,7 +1,8 @@
 ## master
 
-- Table of contents(` docs/README.md`) is now optional
+- Table of contents (`docs/README.md`) is now optional
 - Markdown code is now stripped out of TOC names
+- The first page will always be the home page
 
 ## [v0.2.0]
 > Oct 12, 2015

lib/index.js

@@ -178,10 +178,6 @@ function buildIndex (files, ms, done) {
     contents: JSON.stringify(data, null, 2) + '\n'
   })
 
-  Object.keys(files).forEach((fname) => {
-    const file = files[fname]
-  })
-
   done()
 }
 

lib/tocify.js

@@ -22,6 +22,7 @@ module.exports = function tocify (md, files, options) {
   var current = re
   var docs = options && options.docs || 'docs'
   var scope
+  var i = 0
 
   tokens.forEach((token) => {
     switch (token.type) {
@@ -31,7 +32,7 @@ module.exports = function tocify (md, files, options) {
         break
 
       case 'text':
-        current = itemify(token.text, docs, files)
+        current = itemify(token.text, docs, files, i++)
         scope.push(current)
         break
 
@@ -57,7 +58,7 @@ module.exports = function tocify (md, files, options) {
  * - `anchor`
  */
 
-function itemify (text, docs, files) {
+function itemify (text, docs, files, i) {
   const docsExpr = new RegExp('^' + docs + '/')
   const current = {}
 
@@ -83,9 +84,14 @@ function itemify (text, docs, files) {
     }
     if (source.substr(0, 1) !== '/') source = normalize(docs + '/' + source)
     source = source.replace(/^\//, '')
-    url = source.replace(/\.md$/, '.html')
-    url = url.replace(/README\.html$/, 'index.html')
-    url = url.replace(docsExpr, '')
+
+    if (i === 0) {
+      url = 'index.html'
+    } else {
+      url = source.replace(/\.md$/, '.html')
+      url = url.replace(/README\.html$/, 'index.html')
+      url = url.replace(docsExpr, '')
+    }
   }
 
   current.title = title

test/index/auto_index_test.js

@@ -0,0 +1,30 @@
+const compile = require('../../index')()
+
+describe('index/auto index:', function () {
+  beforeEach(function (done) {
+    // Mock metalsmith object
+    var ms = {
+      metadata () {
+        return { docs: 'docs' }
+      }
+    }
+
+    this.files = {
+      'docs/Readme.md': {
+        contents: '* [First page](foo/bar/baz.md)'
+      },
+      'docs/foo/bar/baz.md': {
+        contents: '# Introduction\n'
+      }
+    }
+
+    compile(this.files, ms, (err) => {
+      if (err) throw err
+      done()
+    })
+  })
+
+  it('renders', function () {
+    expect(this.files['index.html']).toExist()
+  })
+})

test/index/basic_test.js

@@ -11,7 +11,12 @@ describe('index/basic:', function () {
 
     this.files = {
       'docs/README.md': {
-        contents: '* [Intro](intro.md)'
+        contents:
+          '* [My project](../README.md)\n' +
+          '* [Intro](intro.md)\n'
+      },
+      'README.md': {
+        contents: '# My project\n'
       },
       'docs/intro.md': {
         contents: '# Introduction\n'

test/index/fix_links_with_anchors_test.js

@@ -12,9 +12,13 @@ describe('index/fix links with anchors:', function () {
     this.files = {
       'docs/README.md': {
         contents:
+          '* [Hi](../README.md)\n' +
           '* [Introduction](/docs/introduction.md)\n' +
           '* [Getting started](/docs/getting-started.md)\n'
       },
+      'README.md': {
+        contents: '# hi'
+      },
       'docs/getting-started.md': {
         contents: 'hi'
       },

test/index/fix_refs_recursive_test.js

@@ -12,9 +12,13 @@ describe('index/fix refs recursive:', function () {
     this.files = {
       'docs/README.md': {
         contents:
+          '* [My project](/README.md)\n' +
           '* [Introduction](/docs/introduction.md)\n' +
           '* [Getting started](/docs/getting-started.md)\n'
       },
+      'README.md': {
+        contents: '# Readme'
+      },
       'docs/getting-started.md': {
         contents: 'hi'
       },

test/index/linkify_test.js

@@ -11,7 +11,12 @@ describe('index/linkify:', function () {
 
     this.files = {
       'docs/README.md': {
-        contents: '* [Intro](intro.md)'
+        contents:
+          '* [README](../README.md)\n' +
+          '* [Intro](intro.md)'
+      },
+      'README.md': {
+        contents: '# Readme'
       },
       'docs/intro.md': {
         contents: 'http://google.com'

test/index/readme_case_sensitivity_test.js

@@ -11,9 +11,9 @@ describe('index/readme case sensitivity:', function () {
 
     this.files = {
       'docs/Readme.md': {
-        contents: '* [Intro](intro.md)'
+        contents: '* [Intro](../README.md)'
       },
-      'docs/intro.md': {
+      'README.md': {
         contents: '# Introduction\n'
       }
     }
@@ -25,6 +25,6 @@ describe('index/readme case sensitivity:', function () {
   })
 
   it('renders', function () {
-    expect(this.files['intro.html']).toExist()
+    expect(this.files['index.html']).toExist()
   })
 })

test/index/toc_with_anchor_test.js

@@ -11,7 +11,12 @@ describe('index/toc with anchor:', function () {
 
     this.files = {
       'docs/README.md': {
-        contents: '* [Intro](intro.md#xyz)'
+        contents:
+          '* [Readme](../README.md)\n' +
+          '* [Intro](intro.md#xyz)\n'
+      },
+      'README.md': {
+        contents: '# Readme'
       },
       'docs/intro.md': {
         contents: '# Introduction\n'
@@ -29,6 +34,6 @@ describe('index/toc with anchor:', function () {
   })
 
   it('sets .anchor', function () {
-    expect(this.files['_docpress.json'].toc.sections[0].anchor).toEqual('#xyz')
+    expect(this.files['_docpress.json'].toc.sections[1].anchor).toEqual('#xyz')
   })
 })