Docs: GitHub Pages instructions #6384
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
suggested changes
Sep 25, 2017
docs/_docs/github-pages.md
Outdated
| you will not be caught by unexpected differences between various versions of the | ||
| gems. | ||
|
|
||
| GitHub Pages runs in `safe` mode and only allow [a set of whitelisted plugins](https://help.github.com/articles/configuring-jekyll-plugins/#default-plugins), |
There was a problem hiding this comment.
I wish we had Sedy on the repo 😄
There was a problem hiding this comment.
split line at around 80 chars..
docs/_docs/github-pages.md
Outdated
| gems. | ||
|
|
||
| GitHub Pages runs in `safe` mode and only allow [a set of whitelisted plugins](https://help.github.com/articles/configuring-jekyll-plugins/#default-plugins), | ||
| using the `github-pages` gem instead of Jekyll provides you with the same |
There was a problem hiding this comment.
maybe rewrite this to , providing you with the same environment?
docs/_docs/github-pages.md
Outdated
| <div class="note"> | ||
| <h5>GitHub Pages Documentation, Help, and Support</h5> | ||
| <div class="note info"> | ||
| <h5>Installing <code>github-pages</code> gem on Windows</h5> |
docs/_docs/github-pages.md
Outdated
| <a href="https://help.github.com/categories/github-pages-basics/">GitHub’s Pages Help section</a>. | ||
| If all else fails, you should contact <a href="https://github.com/contact">GitHub Support</a>. | ||
| While Windows is not officially supported, it is possible | ||
| to install <code>github-pages</code> gem on Windows. |
ashmaroli
reviewed
Sep 25, 2017
docs/_docs/github-pages.md
Outdated
| `github.io` domain or on a custom domain name of your choice. GitHub Pages are | ||
| powered by Jekyll behind the scenes, so in addition to supporting regular HTML | ||
| content, they’re also a great way to host your Jekyll-powered website for free. | ||
| `github.io` domain or on a custom domain name of your choice. GitHub Pages are powered by Jekyll behind the scenes, so they're a great way to host your Jekyll-powered website for free. |
There was a problem hiding this comment.
IMO, GitHub Pages is a singular entity.. so the sentence should ideally be GitHub Pages is powered by..
Also, it'd be better if the line was split at around 80 chars like elsewhere on this doc..
docs/_docs/github-pages.md
Outdated
| Jonathan McGlone to get you up and running](http://jmcglone.com/guides/github-pages/). | ||
| This guide will teach you what you need to know about Git, GitHub, and Jekyll to create your very own website on GitHub Pages. | ||
| Jonathan McGlone to get you up and | ||
| running](http://jmcglone.com/guides/github-pages/). This guide will teach you |
There was a problem hiding this comment.
i believe the link text could be better shortened as follows:
- [See this marvelous guide by Jonathan McGlone to get you up and running](http://jmcglone.com/guides/github-pages/)
+ [See this marvelous guide by Jonathan McGlone](http://jmcglone.com/guides/github-pages/) to get you up and running
docs/_docs/github-pages.md
Outdated
| you will not be caught by unexpected differences between various versions of the | ||
| gems. | ||
|
|
||
| GitHub Pages runs in `safe` mode and only allow [a set of whitelisted plugins](https://help.github.com/articles/configuring-jekyll-plugins/#default-plugins), |
There was a problem hiding this comment.
split line at around 80 chars..
| will resolve properly. | ||
|
|
||
| ## Deploying Jekyll to GitHub Pages | ||
|
|
||
| GitHub Pages work by looking at certain branches of repositories on GitHub. | ||
| There are two basic types available: user/organization pages and project pages. | ||
| There are two basic types available: [user/organization and project pages](https://help.github.com/articles/user-organization-and-project-pages/). | ||
| The way to deploy these two types of sites are nearly identical, except for a |
There was a problem hiding this comment.
split line at around 80 chars.. ?
- Clarify `pages-gem` intent - Update Gemfile example - Use URL filters for links to assets
775330c to
b28930a
Compare
|
Thanks for the feedback, incorporated your suggestions. |
ghost
approved these changes
Sep 25, 2017
|
@jekyllbot: merge +docs |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
pages-gemintent (fix docs RFE: more explicit context about when the tip: "Use the github-pages gem" applies #6187)