dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Remove GitHub Pages content which is in GitHub docs (#8533) 

Merge pull request 8533
This commit is contained in:
Ben Whetton 2021-01-12 23:44:28 +00:00 committed by GitHub
parent e9d7934156
commit 13152e1247
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
docs/_docs/github-pages.md
View File

@ -15,40 +15,20 @@ simply because Jekyll treats files without front matter as static assets.
So if you only need to push generated HTML, you're good to go without any So if you only need to push generated HTML, you're good to go without any
further setup. further setup.
Never built a website with GitHub Pages before? [See this marvelous guide by The [GitHub Pages Documentation](https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages)
Jonathan McGlone](http://jmcglone.com/guides/github-pages/) to get you up and is comprehensive and includes a [a guide to setting up a GitHub Pages site using
running. This guide will teach you what you need to know about Git, GitHub, and Jekyll](https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/setting-up-a-github-pages-site-with-jekyll).
Jekyll to create your very own website on GitHub Pages. We recommend following this guide.
## The github-pages gem This page contains some additional information which may be useful when working
on GitHub Pages sites with Jekyll.
Our friends at GitHub have provided the
[github-pages](https://github.com/github/pages-gem) gem which is used to manage
[Jekyll and its dependencies on GitHub Pages](https://pages.github.com/versions/).
Using it in your projects means that when you deploy your site to GitHub Pages,
you will not be caught by unexpected differences between various versions of the
gems.
Note that GitHub Pages runs in `safe` mode and only allows [a set of whitelisted
plugins](https://help.github.com/articles/configuring-jekyll-plugins/#default-plugins).
To use the currently-deployed version of the gem in your project, add the
following to your `Gemfile`:
```ruby
source "https://rubygems.org"
gem "github-pages", group: :jekyll_plugins
```
Be sure to run `bundle update` often.
<div class="note"> <div class="note">
<h5>GitHub Pages Documentation, Help, and Support</h5> <h5>GitHub Pages Documentation, Help, and Support</h5>
<p> <p>
For more information about what you can do with GitHub Pages, as well as for For more information about what you can do with GitHub Pages, as well as for
troubleshooting guides, you should check out troubleshooting guides, you should check out
<a href="https://help.github.com/categories/github-pages-basics/">GitHub’s Pages Help section</a>. <a href="https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages">GitHub’s Pages Help section</a>.
If all else fails, you should contact <a href="https://github.com/contact">GitHub Support</a>. If all else fails, you should contact <a href="https://github.com/contact">GitHub Support</a>.
</p> </p>
</div> </div>
@ -76,7 +56,7 @@ will resolve properly.
## Deploying Jekyll to GitHub Pages ## Deploying Jekyll to GitHub Pages
GitHub Pages work by looking at certain branches of repositories on GitHub. GitHub Pages work by looking at certain branches of repositories on GitHub.
There are two basic types available: [user/organization and project pages](https://help.github.com/articles/user-organization-and-project-pages/). There are two basic types available: [user/organization and project pages](https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites).
The way to deploy these two types of sites are nearly identical, except for a The way to deploy these two types of sites are nearly identical, except for a
few minor details. few minor details.
@ -115,7 +95,7 @@ looking at right now is contained in the [docs
folder]({{ site.repository }}/tree/master/docs) of the same repository. folder]({{ site.repository }}/tree/master/docs) of the same repository.
Please refer to GitHub official documentation on Please refer to GitHub official documentation on
[user, organization and project pages](https://help.github.com/articles/user-organization-and-project-pages/) [user, organization and project pages](https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites)
to see more detailed examples. to see more detailed examples.
<div class="note warning"> <div class="note warning">