fine tune doc on github api

This commit is contained in:
tomjohnson1492
2017-01-27 07:25:26 -08:00
parent b468d0682b
commit 0152400034
2 changed files with 6 additions and 6 deletions

View File

@ -111,7 +111,7 @@ The vanilla Jekyll site you create through `jekyll new my-awesome-site` doesn't
2. Type `jekyll serve`
3. Go to the preview address in the browser. (Make sure you include the `/` at the end.)
## Resolving Github Metadata errors {#githuberror}
## Resolve "No Github API authentication" errors {#githuberror}
After making an edit, Jekyll auto-rebuilds the site. If you have the Gemfile in the theme with the github-pages gem, you may see the following error:
@ -119,11 +119,11 @@ After making an edit, Jekyll auto-rebuilds the site. If you have the Gemfile in
GitHub Metadata: No GitHub API authentication could be found. Some fields may be missing or have incorrect data.
```
If so, you will need to take some additional steps to resolve it. (Note that this error only appears if you have the github-pages gem in your gemfile.) The resolution involves adding a Github token and a cert file.
If you see this error, you will need to take some additional steps to resolve it. (Note that this error only appears if you have the github-pages gem in your gemfile.) The resolution involves adding a Github token and a cert file.
{% include note.html content="These instructions apply to Mac OS X, but they're highly similar to Windows. These instructions are adapted from a post on [Knight Codes](http://knightcodes.com/miscellaneous/2016/09/13/fix-github-metadata-error.html). If you're on Windows, see the Knight Codes post for details instead of following along below." %}
To resolve the "No GitHub API" error:
To resolve the "No Github API authentication" error:
1. Follow Github's instructions to [create a personal access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/).
2. Open the **.bash_profile** file in your user directory:
@ -134,7 +134,7 @@ To resolve the "No GitHub API" error:
The file will open in your default terminal editor. If you don't have a .bash_profile file, you can just create a file with this name. Note that files that begin with `.` are hidden, so if you're looking in your user directory for the file, use `ls -a` to see hidden files.
3. In your .bash_profile file, reference your token as a system variable like this:
3. In your **.bash_profile** file, reference your token as a system variable like this:
```
export JEKYLL_GITHUB_TOKEN=abc123abc123abc123abc123abc123abc123abc123abc123