Merge pull request #37 from commitd/mc-fix-upward-relative-links

Author: stuarthendren

example/docs/tests/a/index.md

@@ -2,15 +2,15 @@
 
 This file is the index.md in the `a` folder. It appears on the path as with a trailing slash.
 
-To link relatively to the folder `b` you should use, [b/](b/) or [b/index](b/index) the last has the advantage that is also works in the raw markdown. A full link is also valid [/tests/a/b/](/tests/a/b/) or [/tests/a/b/index](/tests/a/b/index) linking to headings is also supported [b/#link-test](b/#link-test) and [b/index#link-test](b/index#link-test).
+To link relatively to the folder `b` you should use, [b/](b/) or [b/index](b/index) the last has the advantage that is also works in the raw markdown. A full link is also valid [/tests/a/b/](/tests/a/b/) or [/tests/a/b/index](/tests/a/b/index) linking to headings is also supported [b/#link-test](b/#link-test) and [b/index#link-test](b/index#link-test). 
+
+You can also link 'up' directories, for example: [../a](../a), [../../tests/mdTest](../../tests/mdTest), [../../tests/a/b#link-test](../../tests/a/b#link-test)
 
 We consider paths as case insensitive, so the following also work [B/](B/) or [B/Index](B/Index).
 
 The following are invalid.
 
 ```markdown
-[../](../) // not supported
-[../a](../a) // not supported
 [a/b/c/d](a/b/c/d) // missing
 [b/#link-test](b/#link-tests) // missing
 ```

example/package.json

@@ -1,6 +1,6 @@
 {
   "name": "example",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "main": "index.js",
   "author": "Committed <[email protected]>",
   "license": "MIT",

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@committed/gatsby-theme-docs-workspace",
   "private": true,
-  "version": "2.1.1",
+  "version": "2.1.2",
   "main": "index.js",
   "license": "MIT",
   "scripts": {

theme/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@committed/gatsby-theme-docs",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "main": "index.js",
   "author": "Committed <[email protected]>",
   "license": "MIT",

theme/plugins/check-links/index.js

@@ -6,8 +6,30 @@ function getCacheKey(node) {
   return `check-links-${node.id}-${node.internal.contentDigest}`
 }
 
+function getNthPosition(string, subString, n) {
+  return string.split(subString, n).join(subString).length;
+}
+
+function convertToAbsolutePath(link, path) {
+  const moveUpDirectoryCount = (link.match(/\.\.\//g) || []).length
+  let pathWithoutTrailingSlash = path[path.length - 1] === '/' ? path.slice(0, path.length - 1) : path
+  const pathSlashCount = (path.match(/\//g) || []).length
+  const indexToSliceTo = getNthPosition(pathWithoutTrailingSlash, '/', pathSlashCount - moveUpDirectoryCount) + 1
+  const slicedPath = pathWithoutTrailingSlash.slice(0, indexToSliceTo)
+  const slicedLink = link.slice(moveUpDirectoryCount * 3, link.length)
+  return slicedPath.concat(slicedLink)
+}
+
+function convertToBasePath(link, path) {
+  if (link.startsWith('../')) {
+    return convertToAbsolutePath(link, path).toLowerCase()
+  }
+  return link.toLowerCase().replace(/^\.\//, '') // strip ./
+
+}
+
 function getHeadingsMapKey(link, path) {
-  let basePath = link.toLowerCase().replace(/^\.\//, '') // strip ./
+  let basePath = convertToBasePath(link, path)
   const hashIndex = basePath.indexOf('#')
   const hasHash = hashIndex !== -1
   const hashId = hasHash ? basePath.slice(hashIndex + 1) : null
@@ -121,7 +143,8 @@ module.exports = async (
           return false
         }
 
-        const headings = headingsMap[key]
+        // If no heading is found, try again with a trailing /
+        const headings = headingsMap[key] == null ? headingsMap[`${key}/`] : headingsMap[key]
         if (headings) {
           if (hasHash) {
             return (