Merge pull request #45 from primer/update-repo-root-path

Simplify repoRootPath option

Author: colebemis

docs/content/usage/customization.mdx

@@ -41,7 +41,7 @@ _Note: Doctocat only supports one level of nesting._
 
 ## Edit on GitHub link
 
-To add an "Edit this page on GitHub" link to the bottom of every page, add a [`repository`](https://docs.npmjs.com/files/package.json#repository) field in `package.json` and a `repoRootPath` theme option in `gatsby-config.js`:
+To add an "Edit this page on GitHub" link to the bottom of every page, you'll need to specify your site's [`repository`](https://docs.npmjs.com/files/package.json#repository) in `package.json`:
 
 ```json
 // package.json
@@ -50,22 +50,22 @@ To add an "Edit this page on GitHub" link to the bottom of every page, add a [`r
 }
 ```
 
+If your site is located in a subdirectory of a repository, you'll also need to provide the relative path to the root of your git respository via the `repoRootPath` option in `gatsby-config.js`:
+
 ```js
 // gatsby-config.js
 module.exports = {
   plugins: [
     {
       resolve: '@primer/gatsby-theme-doctocat',
       options: {
-        repoRootPath: process.cwd(),
+        repoRootPath: '..', // defaults to '.'
       },
     },
   ],
 }
 ```
 
-The `repoRootPath` option specifies the absolute path to the root of your git repository. If your `gatsby-config.js` is located at the root of your git respository, set `repoRootPath` to [`process.cwd()`](https://nodejs.org/api/process.html#process_process_cwd). If your `gatsby-config.js` is located in a subdirectory, you can use [`path.resolve()`](https://nodejs.org/docs/latest/api/path.html#path_path_resolve_paths), `process.cwd()`, and the relative path to the root of your git repository to compute the absolute path. For example, if your `gatsby-config.js` is located in a `docs` directory set `repoRootpath` to `path.resolve(process.cwd(), '..')`.
-
 ## Hero
 
 To add a hero section to a page, you'll need to override the default layout component with Doctocat's `HeroLayout` component by exporting it from your MDX file:

docs/gatsby-config.js

@@ -1,5 +1,3 @@
-const path = require('path')
-
 module.exports = {
   siteMetadata: {
     title: 'Doctocat',
@@ -10,7 +8,7 @@ module.exports = {
     {
       resolve: '@primer/gatsby-theme-doctocat',
       options: {
-        repoRootPath: path.resolve(process.cwd(), '../..'),
+        repoRootPath: '..',
       },
     },
   ],

theme/gatsby-node.js

@@ -7,14 +7,14 @@ const getRepo = memoize(() => {
   return getPkgRepo(readPkgUp.sync().package)
 })
 
-function generateEditUrl(rootPath, absolutePath) {
+function generateEditUrl(rootAbsolutePath, fileAbsolutePath) {
   try {
     const {domain, user, project} = getRepo()
-    const relativePath = path.relative(rootPath, absolutePath)
-    return `https://${domain}/${user}/${project}/edit/master/${relativePath}`
+    const fileRelativePath = path.relative(rootAbsolutePath, fileAbsolutePath)
+    return `https://${domain}/${user}/${project}/edit/master/${fileRelativePath}`
   } catch (error) {
     console.warn(
-      `[warning] An edit url could not be generated for ${absolutePath}`,
+      `[warning] An edit url could not be generated for ${fileAbsolutePath}`,
     )
     return null
   }
@@ -44,11 +44,13 @@ exports.createPages = async ({graphql, actions}, themeOptions) => {
       node.parent.name === 'index' ? '/' : node.parent.name,
     )
 
-    const editUrl = generateEditUrl(
-      themeOptions.repoRootPath,
-      node.fileAbsolutePath,
+    const rootAbsolutePath = path.resolve(
+      process.cwd(),
+      themeOptions.repoRootPath || '.',
     )
 
+    const editUrl = generateEditUrl(rootAbsolutePath, node.fileAbsolutePath)
+
     actions.createPage({
       path: pagePath,
       component: node.fileAbsolutePath,

theme/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@primer/gatsby-theme-doctocat",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "main": "index.js",
   "license": "MIT",
   "devDependencies": {