From 4c588dfcd2bdb0a9f8d293bac1d5badad5da9976 Mon Sep 17 00:00:00 2001 From: Matej Plavevski Date: Sat, 9 Mar 2019 20:55:34 +0100 Subject: [PATCH 1/4] Update Readme explaining #48 --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index a79c148..7b99d7d 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,24 @@ bundle install ``` bundle exec jekyll serve ``` + +You should see something like: + +``` +Configuration file: /octocat/personal-website/_config.yml + Source: /octocat/personal-website + Destination: /octocat/_site + Incremental build: disabled. Enable with --incremental + Generating... + GitHub Metadata: No GitHub API authentication could be found. Some fields may be missing or have incorrect data. + done in 14.729 seconds. + Auto-regeneration: enabled for '/octocat/personal-website' + Server address: http://127.0.0.1:4000 + Server running... press ctrl-c to stop. +``` + +Don't worry about the GitHub API errors. They are caused because it's run in a dev enviornment and not on GitHub Pages. + 6. Now browse to [http://localhost:4000](http://localhost:4000) ### Publish From 03ce0c2a44d72854fa3758527ab74199021d8f19 Mon Sep 17 00:00:00 2001 From: Matej Plavevski Date: Wed, 13 Mar 2019 22:09:09 +0100 Subject: [PATCH 2/4] Add about Jekyll_github_token --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 7b99d7d..33c0c13 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,8 @@ Configuration file: /octocat/personal-website/_config.yml Don't worry about the GitHub API errors. They are caused because it's run in a dev enviornment and not on GitHub Pages. +You can set a GitHub API Token by setting the JEKYLL_GITHUB_TOKEN to your personal access token. + 6. Now browse to [http://localhost:4000](http://localhost:4000) ### Publish From df4dec6bccae2dbabcf2e2ab902e440f2eb87b3f Mon Sep 17 00:00:00 2001 From: Matej Plavevski Date: Sun, 17 Mar 2019 15:03:44 +0100 Subject: [PATCH 3/4] Implement Changes --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 33c0c13..6509e34 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ Configuration file: /octocat/personal-website/_config.yml Don't worry about the GitHub API errors. They are caused because it's run in a dev enviornment and not on GitHub Pages. -You can set a GitHub API Token by setting the JEKYLL_GITHUB_TOKEN to your personal access token. +You can set a GitHub API Token by setting the `JEKYLL_GITHUB_TOKEN` to your personal access token. 6. Now browse to [http://localhost:4000](http://localhost:4000) From 06a97dca32e5858192ddd123f313a0211325de2b Mon Sep 17 00:00:00 2001 From: Brandon Rosage Date: Mon, 25 Mar 2019 11:50:03 -0500 Subject: [PATCH 4/4] revised language about API authentication --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6509e34..ea5aa4e 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ Configuration file: /octocat/personal-website/_config.yml Source: /octocat/personal-website Destination: /octocat/_site Incremental build: disabled. Enable with --incremental - Generating... + Generating... GitHub Metadata: No GitHub API authentication could be found. Some fields may be missing or have incorrect data. done in 14.729 seconds. Auto-regeneration: enabled for '/octocat/personal-website' @@ -59,9 +59,7 @@ Configuration file: /octocat/personal-website/_config.yml Server running... press ctrl-c to stop. ``` -Don't worry about the GitHub API errors. They are caused because it's run in a dev enviornment and not on GitHub Pages. - -You can set a GitHub API Token by setting the `JEKYLL_GITHUB_TOKEN` to your personal access token. +Don't worry about the "No GitHub API authentication could be found" message. [API authentication is only necessary](https://github.com/jekyll/github-metadata/blob/master/docs/authentication.md) if you intend to display more detailed metadata, like a branch name. 6. Now browse to [http://localhost:4000](http://localhost:4000)