Merge pull request #183 from primer/edit-links

Allow for default branches other than 'master'

Author: emplums

docs/content/usage/customization.mdx

@@ -59,6 +59,8 @@ To enable these features, you'll need to specify your site's [`repository`](http
 }
 ```
 
+## Subdirectories
+
 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
@@ -75,6 +77,24 @@ module.exports = {
 }
 ```
 
+### Default branch
+
+If your site uses a branch other than `master` for your default branch, you'll also need to let Doctocat know via the `defaultBranch` option in `gatsby-config.js`:
+
+```js
+// gatsby-config.js
+module.exports = {
+  plugins: [
+    {
+      resolve: '@primer/gatsby-theme-doctocat',
+      options: {
+        defaultBranch: 'main', // defaults to 'master'
+      },
+    },
+  ],
+}
+```
+
 ## Contributors
 
 If you have the `repository` in `package.json` and `repoRootPath` in `gatsby-config.js` set up correctly (as described [above](#edit-on-github-link)), Doctocat will automatically display contributors on the bottom of every page, like so:

theme/gatsby-node.js

@@ -52,8 +52,8 @@ exports.createPages = async ({graphql, actions}, themeOptions) => {
         rootAbsolutePath,
         node.fileAbsolutePath,
       )
-
-      const editUrl = getEditUrl(repo, fileRelativePath)
+      const defaultBranch = themeOptions.defaultBranch || 'master'
+      const editUrl = getEditUrl(repo, fileRelativePath, defaultBranch)
 
       let contributors = []
       if (process.env.GITHUB_TOKEN || process.env.NOW_GITHUB_DEPLOYMENT) {
@@ -83,8 +83,8 @@ exports.createPages = async ({graphql, actions}, themeOptions) => {
   )
 }
 
-function getEditUrl(repo, filePath) {
-  return `https://github.com/${repo.user}/${repo.project}/edit/master/${filePath}`
+function getEditUrl(repo, filePath, defaultBranch) {
+  return `https://github.com/${repo.user}/${repo.project}/edit/${defaultBranch}/${filePath}`
 }
 
 async function fetchContributors(repo, filePath, accessToken = "") {

theme/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@primer/gatsby-theme-doctocat",
-  "version": "0.25.2",
+  "version": "0.25.3",
   "main": "index.js",
   "license": "MIT",
   "scripts": {