diff --git a/Gemfile b/Gemfile index b301eda..f94f65e 100644 --- a/Gemfile +++ b/Gemfile @@ -1,10 +1,3 @@ source "https://rubygems.org" - -gem "jekyll", "3.3.1" - - -group :jekyll_plugins do - gem "jekyll-feed", "~> 0.6" - gem 'github-pages', '~> 106' -end +gem 'github-pages', group: :jekyll_plugins \ No newline at end of file diff --git a/Gemfile.lock b/Gemfile.lock index 6db904e..352091d 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -7,52 +7,71 @@ GEM minitest (~> 5.1) thread_safe (~> 0.3, >= 0.3.4) tzinfo (~> 1.1) - addressable (2.4.0) + addressable (2.5.0) + public_suffix (~> 2.0, >= 2.0.2) coffee-script (2.4.1) coffee-script-source execjs - coffee-script-source (1.11.1) + coffee-script-source (1.12.2) colorator (1.1.0) ethon (0.10.1) ffi (>= 1.3.0) execjs (2.7.0) - faraday (0.10.0) + faraday (0.11.0) multipart-post (>= 1.2, < 3) - ffi (1.9.14) + ffi (1.9.17) forwardable-extended (2.6.0) gemoji (2.1.0) - github-pages (106) + github-pages (117) activesupport (= 4.2.7) - github-pages-health-check (= 1.2.0) + github-pages-health-check (= 1.3.0) jekyll (= 3.3.1) jekyll-avatar (= 0.4.2) jekyll-coffeescript (= 1.0.1) + jekyll-default-layout (= 0.1.4) jekyll-feed (= 0.8.0) jekyll-gist (= 1.4.0) - jekyll-github-metadata (= 2.2.0) + jekyll-github-metadata (= 2.3.1) jekyll-mentions (= 1.2.0) + jekyll-optional-front-matter (= 0.1.2) jekyll-paginate (= 1.1.0) + jekyll-readme-index (= 0.0.3) jekyll-redirect-from (= 0.11.0) jekyll-relative-links (= 0.2.1) - jekyll-sass-converter (= 1.3.0) + jekyll-sass-converter (= 1.5.0) jekyll-seo-tag (= 2.1.0) jekyll-sitemap (= 0.12.0) jekyll-swiss (= 0.4.0) + jekyll-theme-architect (= 0.0.3) + jekyll-theme-cayman (= 0.0.3) + jekyll-theme-dinky (= 0.0.3) + jekyll-theme-hacker (= 0.0.3) + jekyll-theme-leap-day (= 0.0.3) + jekyll-theme-merlot (= 0.0.3) + jekyll-theme-midnight (= 0.0.3) + jekyll-theme-minimal (= 0.0.3) + jekyll-theme-modernist (= 0.0.3) + jekyll-theme-primer (= 0.1.7) + jekyll-theme-slate (= 0.0.3) + jekyll-theme-tactile (= 0.0.3) + jekyll-theme-time-machine (= 0.0.3) + jekyll-titles-from-headings (= 0.1.4) jemoji (= 0.7.0) kramdown (= 1.11.1) liquid (= 3.0.6) listen (= 3.0.6) mercenary (~> 0.3) minima (= 2.0.0) + nokogiri (= 1.6.8.1) rouge (= 1.11.1) terminal-table (~> 1.4) - github-pages-health-check (1.2.0) + github-pages-health-check (1.3.0) addressable (~> 2.3) net-dns (~> 0.8) octokit (~> 4.0) - public_suffix (~> 1.4) + public_suffix (~> 2.0) typhoeus (~> 0.7) - html-pipeline (2.4.2) + html-pipeline (2.5.0) activesupport (>= 2) nokogiri (>= 1.4) i18n (0.7.0) @@ -71,29 +90,63 @@ GEM jekyll (~> 3.0) jekyll-coffeescript (1.0.1) coffee-script (~> 2.2) + jekyll-default-layout (0.1.4) + jekyll (~> 3.0) jekyll-feed (0.8.0) jekyll (~> 3.3) jekyll-gist (1.4.0) octokit (~> 4.2) - jekyll-github-metadata (2.2.0) + jekyll-github-metadata (2.3.1) jekyll (~> 3.1) octokit (~> 4.0, != 4.4.0) jekyll-mentions (1.2.0) activesupport (~> 4.0) html-pipeline (~> 2.3) jekyll (~> 3.0) + jekyll-optional-front-matter (0.1.2) + jekyll (~> 3.0) jekyll-paginate (1.1.0) + jekyll-readme-index (0.0.3) + jekyll (~> 3.0) jekyll-redirect-from (0.11.0) jekyll (>= 2.0) jekyll-relative-links (0.2.1) jekyll (~> 3.3) - jekyll-sass-converter (1.3.0) - sass (~> 3.2) + jekyll-sass-converter (1.5.0) + sass (~> 3.4) jekyll-seo-tag (2.1.0) jekyll (~> 3.3) jekyll-sitemap (0.12.0) jekyll (~> 3.3) jekyll-swiss (0.4.0) + jekyll-theme-architect (0.0.3) + jekyll (~> 3.3) + jekyll-theme-cayman (0.0.3) + jekyll (~> 3.3) + jekyll-theme-dinky (0.0.3) + jekyll (~> 3.3) + jekyll-theme-hacker (0.0.3) + jekyll (~> 3.3) + jekyll-theme-leap-day (0.0.3) + jekyll (~> 3.3) + jekyll-theme-merlot (0.0.3) + jekyll (~> 3.3) + jekyll-theme-midnight (0.0.3) + jekyll (~> 3.3) + jekyll-theme-minimal (0.0.3) + jekyll (~> 3.3) + jekyll-theme-modernist (0.0.3) + jekyll (~> 3.3) + jekyll-theme-primer (0.1.7) + jekyll (~> 3.3) + jekyll-theme-slate (0.0.3) + jekyll (~> 3.3) + jekyll-theme-tactile (0.0.3) + jekyll (~> 3.3) + jekyll-theme-time-machine (0.0.3) + jekyll (~> 3.3) + jekyll-titles-from-headings (0.1.4) + jekyll (~> 3.3) jekyll-watch (1.5.0) listen (~> 3.0, < 3.1) jemoji (0.7.0) @@ -101,7 +154,7 @@ GEM gemoji (~> 2.0) html-pipeline (~> 2.2) jekyll (>= 3.0) - json (1.8.3) + json (1.8.6) kramdown (1.11.1) liquid (3.0.6) listen (3.0.6) @@ -119,13 +172,13 @@ GEM sawyer (~> 0.8.0, >= 0.5.3) pathutil (0.14.0) forwardable-extended (~> 2.6) - public_suffix (1.5.3) + public_suffix (2.0.5) rb-fsevent (0.9.8) - rb-inotify (0.9.7) + rb-inotify (0.9.8) ffi (>= 0.5.0) rouge (1.11.1) safe_yaml (1.0.4) - sass (3.4.22) + sass (3.4.23) sawyer (0.8.1) addressable (>= 2.3.5, < 2.6) faraday (~> 0.8, < 1.0) @@ -136,15 +189,13 @@ GEM ethon (>= 0.8.0) tzinfo (1.2.2) thread_safe (~> 0.1) - unicode-display_width (1.1.1) + unicode-display_width (1.1.3) PLATFORMS ruby DEPENDENCIES - github-pages (~> 106) - jekyll (= 3.3.1) - jekyll-feed (~> 0.6) + github-pages BUNDLED WITH - 1.13.6 + 1.14.3 diff --git a/_config.yml b/_config.yml index 8cf0cd9..da6047b 100644 --- a/_config.yml +++ b/_config.yml @@ -1,3 +1,4 @@ +repository: tomjohnson1492/documentation-theme-jekyll output: web # this property is useful for conditional filtering of content that is separate from the PDF. diff --git a/pages/mydoc/mydoc_install_jekyll_on_mac.md b/pages/mydoc/mydoc_install_jekyll_on_mac.md index 1690f72..7cf81d7 100644 --- a/pages/mydoc/mydoc_install_jekyll_on_mac.md +++ b/pages/mydoc/mydoc_install_jekyll_on_mac.md @@ -111,4 +111,47 @@ 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} + +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: + +``` + 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. + +{% 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: + +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: + + ``` + open ~/.bash_profile + ``` + + 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: + + ``` + export JEKYLL_GITHUB_TOKEN=abc123abc123abc123abc123abc123abc123abc123abc123 + ``` + + Replace `abc123...` with your own token that you generated in step 1. + +4. Go to **[https://curl.haxx.se/ca/cacert.pem][https://curl.haxx.se/ca/cacert.pem]. Right-click the page, select **Save as**, and save the file on your computer (save it somewhere safe, where you won't delete it). Name the file **cacert**. +5. Open your **.bash_profile** file again and add this line, replacing `Users/johndoe/projects/` with the path to your cacert.pem file: + + ``` + export SSL_CERT_FILE=/Users/johndoe/projects/cacert.pem + ``` + +6. Close and restart your terminal. + +Browse to your jekyll project and run `bundle exec jekyll serve`. Make an edit to a file and observe that no Github API errors appear when Jekyll rebuilds the project. + {% include links.html %} + diff --git a/pages/mydoc/mydoc_install_jekyll_on_windows.md b/pages/mydoc/mydoc_install_jekyll_on_windows.md index 0e85bb0..fdc0244 100644 --- a/pages/mydoc/mydoc_install_jekyll_on_windows.md +++ b/pages/mydoc/mydoc_install_jekyll_on_windows.md @@ -92,4 +92,16 @@ Although you can use the default command prompt with Windows, it's recommended t Unfortunately, the Command Prompt doesn't allow you to easily copy and paste the URL, so you'll have to type it manually. +## Resolving Github Metadata 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: + +``` + 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. + +See this post on [Knight Codes](http://knightcodes.com/miscellaneous/2016/09/13/fix-github-metadata-error.html) for instructions on how to fix the error. You basically generate a personal token on Github and set it as a system variable. You also download a certification file and set it as a system variable. This resolves the issue. + {% include links.html %}