3df90fc9b8
Are you looking for something? Here is all of the GitHub Docs history in one single commit. Enjoy! 🎉
14 KiB
title, intro, redirect_from, product, versions
| title | intro | redirect_from | product | versions | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| About GitHub Pages | You can use {{ site.data.variables.product.prodname_pages }} to host a website about yourself, your organization, or your project directly from a {{ site.data.variables.product.product_name }} repository. |
|
{{ site.data.reusables.gated-features.pages }} |
|
About {{ site.data.variables.product.prodname_pages }}
{{ site.data.variables.product.prodname_pages }} is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on {{ site.data.variables.product.product_name }}, optionally runs the files through a build process, and publishes a website. You can see examples of {{ site.data.variables.product.prodname_pages }} sites in the {{ site.data.variables.product.prodname_pages }} examples collection.
{% if currentVersion == "free-pro-team@latest" %}
You can host your site on {{ site.data.variables.product.prodname_dotcom }}'s github.io domain or your own custom domain. For more information, see "Using a custom domain with {{ site.data.variables.product.prodname_pages }}."
{% endif %}
To get started, see "Creating a {{ site.data.variables.product.prodname_pages }} site."
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} Organization owners can disable the publication of {{ site.data.variables.product.prodname_pages }} sites from the organization's repositories. For more information, see "Disabling publication of {{ site.data.variables.product.prodname_pages }} sites for your organization." {% endif %}
Types of {{ site.data.variables.product.prodname_pages }} sites
There are three types of {{ site.data.variables.product.prodname_pages }} sites: project, user, and organization. Project sites are connected to a specific project hosted on {{ site.data.variables.product.product_name }}, such as a JavaScript library or a recipe collection. User and organization sites are connected to a specific {{ site.data.variables.product.product_name }} account.
To publish a user site, you must create a repository owned by your user account that's named {% if currentVersion == "free-pro-team@latest" %}<user>.github.io{% else %}<user>.<hostname>{% endif %}. To publish an organization site, you must create a repository owned by an organization that's named {% if currentVersion == "free-pro-team@latest" %}<organization>.github.io{% else %}<organization>.<hostname>{% endif %}. {% if currentVersion == "free-pro-team@latest" %}Unless you're using a custom domain, user and organization sites are available at http(s)://<username>.github.io or http(s)://<organization>.github.io.{% endif %}
The source files for a project site are stored in the same repository as their project. {% if currentVersion == "free-pro-team@latest" %}Unless you're using a custom domain, project sites are available at http(s)://<user>.github.io/<repository> or http(s)://<organization>.github.io/<repository>.{% endif %}
{% if currentVersion == "free-pro-team@latest" %} For more information about how custom domains affect the URL for your site, see "About custom domains and {{ site.data.variables.product.prodname_pages }}." {% endif %}
You can only create one user or organization site for each {{ site.data.variables.product.product_name }} account. Project sites, whether owned by an organization or a user account, are unlimited.
{% if currentVersion != "free-pro-team@latest" %} The URL where your site is available depends on whether subdomain isolation is enabled for {{ site.data.variables.product.product_location }}.
| Type of site | Subdomain isolation enabled | Subdomain isolation disabled |
|---|---|---|
| User | http(s)://pages.<hostname>/<username>/<repository>/ |
http(s)://<hostname>/pages/<username>/<repository>/ |
| Organization | http(s)://pages.<hostname>/<organization>/<repository>/ |
http(s)://<hostname>/pages/<organization>/<repository>/ |
| Project site owned by user account | http(s)://pages.<hostname>/<username>/<repository>/ |
http(s)://<hostname>/pages/<username>/<repository>/ |
| Project site owned by organization account | http(s)://pages.<hostname>/<orgname>/<repository>/ |
http(s)://<hostname>/pages/<orgname>/<repository>/ |
For more information, see "[Enabling subdomain isolation](/enterprise/{{ currentVersion }}/admin/installation/enabling-subdomain-isolation)" or contact your site administrator. {% endif %}
{% if currentVersion == "free-pro-team@latest" %} {% note %}
Note: Repositories using the legacy <user>.github.com naming scheme will still be published, but visitors will be redirected from http(s)://<username>.github.com to http(s)://<username>.github.io. If both a <user>.github.com and <user>.github.io repository exist, only the <user>.github.io repository will be published.
{% endnote %} {% endif %}
Publishing sources for {{ site.data.variables.product.prodname_pages }} sites
The publishing source for your {{ site.data.variables.product.prodname_pages }} site is the branch and folder where the source files for your site are stored.
{{ site.data.reusables.pages.private_pages_are_public_warning }}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
If the default publishing source exists in your repository, {{ site.data.variables.product.prodname_pages }} will automatically publish a site from that source. The default publishing source for user and organization sites is the root of the default branch for the repository. The default publishing source for project sites is the root of the gh-pages branch.
If you want to keep the source files for your site in a different location, you can change the publishing source for your site. You can publish your site from any branch in the repository, either from the root of the repository on that branch, /, or from the /docs folder on that branch. For more information, see "Configuring a publishing source for your {{ site.data.variables.product.prodname_pages }} site."
If you choose the /docs folder of any branch as your publishing source, {{ site.data.variables.product.prodname_pages }} will read everything to publish your site{% if currentVersion == "free-pro-team@latest" %}, including the CNAME file,{% endif %} from the /docs folder.{% if currentVersion == "free-pro-team@latest" %} For example, when you edit your custom domain through the {{ site.data.variables.product.prodname_pages }} settings, the custom domain will write to /docs/CNAME. For more information about CNAME files, see "Managing a custom domain for your {{ site.data.variables.product.prodname_pages }} site."{% endif %}
{% else %}
The default publishing source for user and organization sites is the master branch. If the repository for your user or organization site has a master branch, your site will publish automatically from that branch. You cannot choose a different publishing source for user or organization sites.
The default publishing source for a project site is the gh-pages branch. If the repository for your project site has a gh-pages branch, your site will publish automatically from that branch.
Project sites can also be published from the master branch or a /docs folder on the master branch. To publish your site from one of these sources, you must configure a different publishing source. For more information, see "Configuring a publishing source for your {{ site.data.variables.product.prodname_pages }} site."
If you choose the /docs folder of the master branch as your publishing source, {{ site.data.variables.product.prodname_pages }} will read everything to publish your site{% if currentVersion == "free-pro-team@latest" %}, including the CNAME file,{% endif %} from the /docs folder.{% if currentVersion == "free-pro-team@latest" %} For example, when you edit your custom domain through the {{ site.data.variables.product.prodname_pages }} settings, the custom domain will write to /docs/CNAME. For more information about CNAME files, see "Managing a custom domain for your {{ site.data.variables.product.prodname_pages }} site."{% endif %}
You cannot publish your project site from any other branch, even if the default branch is not master or gh-pages.
{% endif %}
Static site generators
{{ site.data.variables.product.prodname_pages }} publishes any static files that you push to your repository. You can create your own static files or use a static site generator to build your site for you. You can also customize your own build process locally or on another server. We recommend Jekyll, a static site generator with built-in support for {{ site.data.variables.product.prodname_pages }} and a simplified build process. For more information, see "About {{ site.data.variables.product.prodname_pages }} and Jekyll."
{{ site.data.variables.product.prodname_pages }} will use Jekyll to build your site by default. If you want to use a static site generator other than Jekyll, disable the Jekyll build process by creating an empty file called .nojekyll in the root of your publishing source, then follow your static site generator's instructions to build your site locally.
{{ site.data.variables.product.prodname_pages }} does not support server-side languages such as PHP, Ruby, or Python.
Guidelines for using {{ site.data.variables.product.prodname_pages }}
{% if currentVersion == "free-pro-team@latest" %}
- {{ site.data.variables.product.prodname_pages }} sites created after June 15, 2016 and using
github.iodomains are served over HTTPS. If you created your site before June 15, 2016, you can enable HTTPS support for traffic to your site. For more information, see "Securing your {{ site.data.variables.product.prodname_pages }} with HTTPS." - {{ site.data.reusables.pages.no_sensitive_data_pages }}
- Your use of {{ site.data.variables.product.prodname_pages }} is subject to the GitHub Terms of Service, including the prohibition on reselling.
Usage limits
{% endif %} {{ site.data.variables.product.prodname_pages }} sites are subject to the following usage limits:
- {{ site.data.variables.product.prodname_pages }} source repositories have a recommended limit of 1GB.{% if currentVersion == "free-pro-team@latest" %} For more information, see "What is my disk quota?"{% endif %}
- Published {{ site.data.variables.product.prodname_pages }} sites may be no larger than 1 GB. {% if currentVersion == "free-pro-team@latest" %}
- {{ site.data.variables.product.prodname_pages }} sites have a soft bandwidth limit of 100GB per month.
- {{ site.data.variables.product.prodname_pages }} sites have a soft limit of 10 builds per hour.
If your site exceeds these usage quotas, we may not be able to serve your site, or you may receive a polite email from {{ site.data.variables.contact.contact_support }} suggesting strategies for reducing your site's impact on our servers, including putting a third-party content distribution network (CDN) in front of your site, making use of other {{ site.data.variables.product.prodname_dotcom }} features such as releases, or moving to a different hosting service that might better fit your needs.
Prohibited uses
{{ site.data.variables.product.prodname_pages }} is not intended for or allowed to be used as a free web hosting service to run your online business, e-commerce site, or any other website that is primarily directed at either facilitating commercial transactions or providing commercial software as a service (SaaS).
Additionally, {{ site.data.variables.product.prodname_pages }} sites must refrain from:
- Content or activity that is illegal or otherwise prohibited by our Terms of Service or Community Guidelines
- Violent or threatening content or activity
- Excessive automated bulk activity (for example, spamming)
- Activity that compromises GitHub users or GitHub services
- Get-rich-quick schemes
- Sexually obscene content
- Content that misrepresents your identity or site purpose
If you have questions about whether your use or intended use falls into these categories, please contact {{ site.data.variables.contact.contact_support }}. {% endif %}
MIME types on {{ site.data.variables.product.prodname_pages }}
A MIME type is a header that a server sends to a browser, providing information about the nature and format of the files the browser requested. {{ site.data.variables.product.prodname_pages }} supports more than 750 MIME types across thousands of file extensions. The list of supported MIME types is generated from the mime-db project.
While you can't specify custom MIME types on a per-file or per-repository basis, you can add or modify MIME types for use on {{ site.data.variables.product.prodname_pages }}. For more information, see the mime-db contributing guidelines.
Further reading
- {{ site.data.variables.product.prodname_pages }} on {{ site.data.variables.product.prodname_learning }}
- "{{ site.data.variables.product.prodname_pages }}"