Make GitHub Pages content a top-level doc set (#18480)

* Add new product to products.yml

* Move directory to new location

* Update new index page

* Remove old category from github product index

* Add getting started category

* Add Jekyll category

* Create custom domain category

* Update links to custom domain articles

* Add redirects and update links for getting started articles

* Add redirects and update links for jekyll articles

* Fix link

* Fix link

* Fix link

* Fix link
This commit is contained in:
Emily Gould 2021-04-01 15:09:50 -05:00 коммит произвёл GitHub
Родитель d928580ea7
Коммит fbc83618dd
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
40 изменённых файлов: 127 добавлений и 110 удалений

Просмотреть файл

@ -24,7 +24,7 @@
"http://localhost:4001/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address",
"http://localhost:4001/en/github/authenticating-to-github/configuring-two-factor-authentication",
"http://localhost:4001/en/rest",
"http://localhost:4001/en/github/working-with-github-pages/configuring-a-custom-domain-for-your-github-pages-site",
"http://localhost:4001/en/pages/configuring-a-custom-domain-for-your-github-pages-site",
"http://localhost:4001/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests",
"http://localhost:4001/en/github/setting-up-and-managing-your-github-user-account/changing-your-primary-email-address",
"http://localhost:4001/en/github/setting-up-and-managing-your-github-profile/why-are-my-contributions-not-showing-up-on-my-profile",
@ -36,17 +36,17 @@
"http://localhost:4001/en/github/authenticating-to-github/testing-your-ssh-connection",
"http://localhost:4001/en/github/getting-started-with-github/fork-a-repo",
"http://localhost:4001/en/graphql",
"http://localhost:4001/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site",
"http://localhost:4001/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site",
"http://localhost:4001/en/developers",
"http://localhost:4001/en/github/getting-started-with-github/supported-browsers",
"http://localhost:4001/en/github/managing-your-work-on-github/about-project-boards",
"http://localhost:4001/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork",
"http://localhost:4001/en/github/working-with-github-pages/creating-a-github-pages-site",
"http://localhost:4001/en/pages/getting-started-with-github-pages/creating-a-github-pages-site",
"http://localhost:4001/en/github/authenticating-to-github/working-with-ssh-key-passphrases",
"http://localhost:4001/en/github/authenticating-to-github",
"http://localhost:4001/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages",
"http://localhost:4001/en/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site",
"http://localhost:4001/en/github/working-with-github-pages/about-github-pages",
"http://localhost:4001/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site",
"http://localhost:4001/en/pages/getting-started-with-github-pages/about-github-pages",
"http://localhost:4001/en/github/setting-up-and-managing-your-github-profile",
"http://localhost:4001/en/actions/getting-started-with-github-actions/about-github-actions",
"http://localhost:4001/en/github/getting-started-with-github",
@ -75,7 +75,7 @@
"http://localhost:4001/en/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository",
"http://localhost:4001/en/github/setting-up-and-managing-your-github-user-account/changing-your-github-username",
"http://localhost:4001/en/github/getting-started-with-github/create-a-repo",
"http://localhost:4001/en/github/working-with-github-pages/getting-started-with-github-pages",
"http://localhost:4001/en/pages/getting-started-with-github-pages",
"http://localhost:4001/en/github/administering-a-repository/deleting-a-repository",
"http://localhost:4001/en/actions/configuring-and-managing-workflows/using-environment-variables",
"http://localhost:4001/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets",
@ -86,7 +86,7 @@
"http://localhost:4001/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue",
"http://localhost:4001/en/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates",
"http://localhost:4001/en/github/authenticating-to-github/about-two-factor-authentication",
"http://localhost:4001/en/github/working-with-github-pages/about-custom-domains-and-github-pages",
"http://localhost:4001/en/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages",
"http://localhost:4001/en/github/searching-for-information-on-github/searching-code",
"http://localhost:4001/en/github/getting-started-with-github/configuring-git-to-handle-line-endings",
"http://localhost:4001/en/github/getting-started-with-github/getting-changes-from-a-remote-repository",
@ -95,7 +95,7 @@
"http://localhost:4001/en/github/creating-cloning-and-archiving-repositories/licensing-a-repository",
"http://localhost:4001/en/github/getting-started-with-github/verifying-your-email-address",
"http://localhost:4001/en/github/setting-up-and-managing-your-github-profile/personalizing-your-profile",
"http://localhost:4001/en/github/working-with-github-pages/setting-up-a-github-pages-site-with-jekyll",
"http://localhost:4001/en/pages/setting-up-a-github-pages-site-with-jekyll",
"http://localhost:4001/en/github/managing-subscriptions-and-notifications-on-github",
"http://localhost:4001/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork"
]

Просмотреть файл

@ -48,7 +48,7 @@ With auto-merge, pull requests can be set to merge automatically when all merge
#### Developer changes
- [Organization owners can now disable publication](/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization) of {% data variables.product.prodname_pages %} sites from repositories in the organization. This will not unpublish existing sites.
- Repositories that use {% data variables.product.prodname_pages %} can now [build and deploy from any branch](/github/working-with-github-pages/about-github-pages#publishing-sources-for-github-pages-sites).
- Repositories that use {% data variables.product.prodname_pages %} can now [build and deploy from any branch](/pages/getting-started-with-github-pages/about-github-pages#publishing-sources-for-github-pages-sites).
- When writing an issue or pull request, the list syntax for bullets, numbers, and tasks will now be autocompleted after you press `return` or `enter`.
- You can now delete a directory in a repository from the repository page. When navigating to a directory, a new kebab button next to the "Add file" button gives the option to delete the directory.
- Its now easier and faster to [reference issues or pull requests](/github/writing-on-github/basic-writing-and-formatting-syntax#referencing-issues-and-pull-requests), with search across multiple words after the "#".

Просмотреть файл

@ -17,7 +17,7 @@ When you rename a repository, all existing information, with the exception of pr
* Stars
* Followers
For more information on project sites, see "[About {% data variables.product.prodname_pages %}](/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites)."
For more information on project sites, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites)."
In addition to redirecting web traffic, all `git clone`, `git fetch`, or `git push` operations targeting the previous location will continue to function as if made on the new location. However, to reduce confusion, we strongly recommend updating any existing local clones to point to the new repository URL. You can do this by using `git remote` on the command line:
@ -29,7 +29,7 @@ For more information, see "[Managing remote repositories](/github/getting-starte
{% if currentVersion == "free-pro-team@latest" %}
If you plan to rename a repository that has a {% data variables.product.prodname_pages %} site, we recommend using a custom domain for your site. This ensures that the site's URL isn't impacted by renaming the repository. For more information, see "[About custom domains and {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/about-custom-domains-and-github-pages)."
If you plan to rename a repository that has a {% data variables.product.prodname_pages %} site, we recommend using a custom domain for your site. This ensures that the site's URL isn't impacted by renaming the repository. For more information, see "[About custom domains and {% data variables.product.prodname_pages %} site](/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages)."
{% endif %}

Просмотреть файл

@ -57,7 +57,6 @@ versions:
{% link_in_list /extending-github %}
{% link_in_list /working-with-github-pages %}
{% link_in_list /supporting-the-open-source-community-with-github-sponsors %}
{% link_in_list /finding-talent-with-github-jobs %}
{% link_in_list /working-with-github-support %}

Просмотреть файл

@ -18,7 +18,7 @@ topics:
If your organization uses {% data variables.product.prodname_ghe_cloud %}, you can choose to allow organization members to create publicly published sites, privately published sites, both, or neither. Otherwise, you can choose to allow or disallow public publishing. For more information about access control for {% data variables.product.prodname_pages %} sites, see "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/changing-the-visibility-of-your-github-pages-site)."
{% endif %}
If you disallow publication of {% data variables.product.prodname_pages %} sites, any sites that are already published will remain published. You can manually unpublish the site. For more information, see "[Unpublishing a {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/unpublishing-a-github-pages-site)."
If you disallow publication of {% data variables.product.prodname_pages %} sites, any sites that are already published will remain published. You can manually unpublish the site. For more information, see "[Unpublishing a {% data variables.product.prodname_pages %} site](/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site)."
{% data reusables.profile.access_profile %}
{% data reusables.profile.access_org %}
@ -32,4 +32,4 @@ If you disallow publication of {% data variables.product.prodname_pages %} sites
### Further reading
- "[About {% data variables.product.prodname_pages %}](/github/working-with-github-pages/about-github-pages)"
- "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)"

Просмотреть файл

@ -25,7 +25,7 @@ Commits will appear on your contributions graph if they meet **all** of the foll
- In the repository's default branch
- In the `gh-pages` branch (for repositories with project sites)
For more information on project sites, see "[About {% data variables.product.prodname_pages %}](/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites)."
For more information on project sites, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites)."
In addition, **at least one** of the following must be true:
- You are a collaborator on the repository or are a member of the organization that owns the repository.
@ -66,7 +66,7 @@ Generic email addresses--such as `jane@computer.local`--cannot be added to {% da
#### Commit was not made in the default or `gh-pages` branch
Commits are only counted if they are made in the default branch or the `gh-pages` branch (for repositories with project sites). For more information, see "[About {% data variables.product.prodname_pages %}](/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites)."
Commits are only counted if they are made in the default branch or the `gh-pages` branch (for repositories with project sites). For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites)."
If your commits are in a non-default or non-`gh-pages` branch and you'd like them to count toward your contributions, you will need to do one of the following:
- [Open a pull request](/articles/creating-a-pull-request) to have your changes merged into the default branch or the `gh-pages` branch.

Просмотреть файл

@ -1,17 +0,0 @@
---
title: Getting started with GitHub Pages
intro: 'You can set up a basic {% data variables.product.prodname_pages %} site for yourself, your organization, or your project.'
redirect_from:
- /categories/github-pages-basics
- /articles/additional-customizations-for-github-pages/
- /articles/getting-started-with-github-pages
product: '{% data reusables.gated-features.pages %}'
mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
topics:
- pages
---

Просмотреть файл

@ -1,47 +0,0 @@
---
title: Working with GitHub Pages
shortTitle: GitHub Pages
intro: 'You can create a website directly from a {% data variables.product.product_name %} repository.'
redirect_from:
- /categories/20/articles/
- /categories/95/articles/
- /categories/github-pages-features/
- /pages/
- /categories/96/articles/
- /categories/github-pages-troubleshooting/
- /categories/working-with-github-pages
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
topics:
- pages
---
### Table of Contents
{% topic_link_in_list /getting-started-with-github-pages %}
{% link_in_list /about-github-pages %}
{% link_in_list /creating-a-github-pages-site %}
{% link_in_list /adding-a-theme-to-your-github-pages-site-with-the-theme-chooser %}
{% link_in_list /configuring-a-publishing-source-for-your-github-pages-site %}
{% link_in_list /changing-the-visibility-of-your-github-pages-site %}
{% link_in_list /creating-a-custom-404-page-for-your-github-pages-site %}
{% link_in_list /securing-your-github-pages-site-with-https %}
{% link_in_list /using-submodules-with-github-pages %}
{% link_in_list /unpublishing-a-github-pages-site %}
{% topic_link_in_list /setting-up-a-github-pages-site-with-jekyll %}
{% link_in_list /about-github-pages-and-jekyll %}
{% link_in_list /creating-a-github-pages-site-with-jekyll %}
{% link_in_list /testing-your-github-pages-site-locally-with-jekyll %}
{% link_in_list /adding-content-to-your-github-pages-site-using-jekyll %}
{% link_in_list /setting-a-markdown-processor-for-your-github-pages-site-using-jekyll %}
{% link_in_list /adding-a-theme-to-your-github-pages-site-using-jekyll %}
{% link_in_list /about-jekyll-build-errors-for-github-pages-sites %}
{% link_in_list /troubleshooting-jekyll-build-errors-for-github-pages-sites %}
{% topic_link_in_list /configuring-a-custom-domain-for-your-github-pages-site %}
{% link_in_list /about-custom-domains-and-github-pages %}
{% link_in_list /managing-a-custom-domain-for-your-github-pages-site %}
{% link_in_list /troubleshooting-custom-domains-and-github-pages %}

Просмотреть файл

@ -1,17 +0,0 @@
---
title: Setting up a GitHub Pages site with Jekyll
intro: 'You can use Jekyll, a popular static site generator, to further customize your {% data variables.product.prodname_pages %} site.'
redirect_from:
- /articles/using-jekyll-with-pages/
- /articles/using-jekyll-as-a-static-site-generator-with-github-pages
- /articles/setting-up-a-github-pages-site-with-jekyll
product: '{% data reusables.gated-features.pages %}'
mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
topics:
- pages
---

Просмотреть файл

@ -6,6 +6,7 @@ redirect_from:
- /articles/about-supported-custom-domains/
- /articles/custom-domain-redirects-for-your-github-pages-site/
- /articles/about-custom-domains-and-github-pages
- /github/working-with-github-pages/about-custom-domains-and-github-pages
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'

Просмотреть файл

@ -10,11 +10,14 @@ redirect_from:
- /articles/setting-up-a-custom-domain-with-pages/
- /articles/setting-up-a-custom-domain-with-github-pages/
- /articles/configuring-a-custom-domain-for-your-github-pages-site
- /github/working-with-github-pages/configuring-a-custom-domain-for-your-github-pages-site
product: '{% data reusables.gated-features.pages %}'
mapTopic: true
versions:
free-pro-team: '*'
topics:
- pages
---
{% link_in_list /about-custom-domains-and-github-pages %}
{% link_in_list /managing-a-custom-domain-for-your-github-pages-site %}
{% link_in_list /troubleshooting-custom-domains-and-github-pages %}

Просмотреть файл

@ -10,6 +10,7 @@ redirect_from:
- /articles/adding-a-cname-file-to-your-repository/
- /articles/setting-up-your-pages-site-repository/
- /articles/managing-a-custom-domain-for-your-github-pages-site
- /github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'

Просмотреть файл

@ -6,6 +6,7 @@ redirect_from:
- /articles/custom-domain-isn-t-working/
- /articles/troubleshooting-custom-domains/
- /articles/troubleshooting-custom-domains-and-github-pages
- /github/working-with-github-pages/troubleshooting-custom-domains-and-github-pages
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'

Просмотреть файл

@ -9,6 +9,7 @@ redirect_from:
- /articles/mime-types-on-github-pages/
- /articles/should-i-rename-usernamegithubcom-repositories-to-usernamegithubio/
- /articles/about-github-pages
- /github/working-with-github-pages/about-github-pages
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'
@ -27,7 +28,7 @@ You can host your site on {% data variables.product.prodname_dotcom %}'s `github
{% endif %}
{% if currentVersion == "free-pro-team@latest" %}
{% data reusables.pages.about-private-publishing %} For more information, see "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/changing-the-visibility-of-your-github-pages-site)."
{% data reusables.pages.about-private-publishing %} For more information, see "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)."
{% endif %}
To get started, see "[Creating a {% data variables.product.prodname_pages %} site](/articles/creating-a-github-pages-site)."
@ -45,7 +46,7 @@ To publish a user site, you must create a repository owned by your user account
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)://<username>.github.io/<repository>` or `http(s)://<organization>.github.io/<repository>`.{% elsif currentVersion == "github-ae@latest" %}Project sites are available at `http(s)://pages.<hostname>/<username>/<repository>/` or `http(s)://pages.<hostname>/<organization>/<repository>/`.{% endif %}
{% if currentVersion == "free-pro-team@latest" %}
If you publish your site privately, the URL for your site will be different. For more information, see "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/changing-the-visibility-of-your-github-pages-site)."
If you publish your site privately, the URL for your site will be different. For more information, see "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)."
{% endif %}
{% if currentVersion == "free-pro-team@latest" %}

Просмотреть файл

@ -5,6 +5,7 @@ redirect_from:
- /articles/creating-a-github-pages-site-with-the-jekyll-theme-chooser/
- /articles/adding-a-jekyll-theme-to-your-github-pages-site-with-the-jekyll-theme-chooser/
- /articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser
- /github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'

Просмотреть файл

@ -9,16 +9,16 @@ permissions: People with admin permissions for a repository can change the visib
### About access control for {% data variables.product.prodname_pages %} sites
If your project site is published from a private or internal repository that's owned by an organization using {% data variables.product.prodname_ghe_cloud %}, you can manage access control for the site. With access control, you can choose to publish the site publicly to anyone on the internet or privately to people with read access to your repository. A privately published site can be used to share your internal documentation or knowledge base with members of your enterprise. You cannot manage access control for an organization site. For more information about the types of {% data variables.product.prodname_pages %} sites, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites)."
If your project site is published from a private or internal repository that's owned by an organization using {% data variables.product.prodname_ghe_cloud %}, you can manage access control for the site. With access control, you can choose to publish the site publicly to anyone on the internet or privately to people with read access to your repository. A privately published site can be used to share your internal documentation or knowledge base with members of your enterprise. You cannot manage access control for an organization site. For more information about the types of {% data variables.product.prodname_pages %} sites, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites)."
Privately published sites are available at a different subdomain than publicly published sites. This ensures that your {% data variables.product.prodname_pages %} site is secure from the moment it's published:
- We automatically secure every subdomain of `*.pages.github.io` with a TLS certificate, and enforce HSTS to ensure that browsers always serve the page over HTTPS.
- We use a unique subdomain for the private page to ensure that other repositories in your organization cannot publish content on the same origin as the private page. This protects your private page from "[cookie tossing](https://github.blog/2013-04-09-yummy-cookies-across-domains/)". This is also why we don't host {% data variables.product.prodname_pages %} sites on the `github.com` domain.
You can see your site's unique subdomain in the pages tab of your repository settings. If you're using a static site generator configured to build the site with the repository name as a path, you may need to update the settings for the static site generator when changing the site to private. For more information, see "[Configuring Jekyll in your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain)" or the documentation for your static site generator.
You can see your site's unique subdomain in the pages tab of your repository settings. If you're using a static site generator configured to build the site with the repository name as a path, you may need to update the settings for the static site generator when changing the site to private. For more information, see "[Configuring Jekyll in your {% data variables.product.prodname_pages %} site](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain)" or the documentation for your static site generator.
To use a shorter and more memorable domain for your private {% data variables.product.prodname_pages %} site, you can configure a custom domain. For more information, see "[Configuring a custom domain for your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/configuring-a-custom-domain-for-your-github-pages-site)."
To use a shorter and more memorable domain for your private {% data variables.product.prodname_pages %} site, you can configure a custom domain. For more information, see "[Configuring a custom domain for your {% data variables.product.prodname_pages %} site](/pages/configuring-a-custom-domain-for-your-github-pages-site)."
### Changing the visibility of your {% data variables.product.prodname_pages %} site

Просмотреть файл

@ -4,6 +4,7 @@ intro: 'If you use the default publishing source for your {% data variables.prod
redirect_from:
- /articles/configuring-a-publishing-source-for-github-pages/
- /articles/configuring-a-publishing-source-for-your-github-pages-site
- /github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site
product: '{% data reusables.gated-features.pages %}'
permissions: 'People with admin or maintainer permissions for a repository can configure a publishing source for a {% data variables.product.prodname_pages %} site.'
versions:

Просмотреть файл

@ -4,6 +4,7 @@ intro: You can display a custom 404 error page when people try to access nonexis
redirect_from:
- /articles/custom-404-pages/
- /articles/creating-a-custom-404-page-for-your-github-pages-site
- /github/working-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'

Просмотреть файл

@ -7,6 +7,7 @@ redirect_from:
- /articles/creating-project-pages-from-the-command-line/
- /articles/creating-project-pages-using-the-command-line/
- /articles/creating-a-github-pages-site
- /github/working-with-github-pages/creating-a-github-pages-site
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'

Просмотреть файл

@ -0,0 +1,26 @@
---
title: Getting started with GitHub Pages
intro: 'You can set up a basic {% data variables.product.prodname_pages %} site for yourself, your organization, or your project.'
redirect_from:
- /categories/github-pages-basics
- /articles/additional-customizations-for-github-pages/
- /articles/getting-started-with-github-pages
- /github/working-with-github-pages/getting-started-with-github-pages
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
topics:
- pages
---
{% link_in_list /about-github-pages %}
{% link_in_list /creating-a-github-pages-site %}
{% link_in_list /adding-a-theme-to-your-github-pages-site-with-the-theme-chooser %}
{% link_in_list /configuring-a-publishing-source-for-your-github-pages-site %}
{% link_in_list /changing-the-visibility-of-your-github-pages-site %}
{% link_in_list /creating-a-custom-404-page-for-your-github-pages-site %}
{% link_in_list /securing-your-github-pages-site-with-https %}
{% link_in_list /using-submodules-with-github-pages %}
{% link_in_list /unpublishing-a-github-pages-site %}

Просмотреть файл

@ -4,6 +4,7 @@ intro: 'HTTPS adds a layer of encryption that prevents others from snooping on o
product: '{% data reusables.gated-features.pages %}'
redirect_from:
- /articles/securing-your-github-pages-site-with-https
- /github/working-with-github-pages/securing-your-github-pages-site-with-https
versions:
free-pro-team: '*'
topics:

Просмотреть файл

@ -7,6 +7,7 @@ redirect_from:
- /articles/unpublishing-a-project-pages-site/
- /articles/unpublishing-a-user-pages-site/
- /articles/unpublishing-a-github-pages-site
- /github/working-with-github-pages/unpublishing-a-github-pages-site
product: '{% data reusables.gated-features.pages %}'
permissions: 'People with admin or maintainer permissions for a repository can unpublish a {% data variables.product.prodname_pages %} site.'
versions:

Просмотреть файл

@ -4,6 +4,7 @@ intro: 'You can use submodules with {% data variables.product.prodname_pages %}
redirect_from:
- /articles/using-submodules-with-pages/
- /articles/using-submodules-with-github-pages
- /github/working-with-github-pages/using-submodules-with-github-pages
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'

25
content/pages/index.md Normal file
Просмотреть файл

@ -0,0 +1,25 @@
---
title: GitHub Pages Documentation
shortTitle: GitHub Pages
intro: 'You can create a website directly from a {% data variables.product.product_name %} repository.'
redirect_from:
- /categories/20/articles/
- /categories/95/articles/
- /categories/github-pages-features/
- /pages/
- /categories/96/articles/
- /categories/github-pages-troubleshooting/
- /categories/working-with-github-pages
- /github/working-with-github-pages
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
topics:
- pages
---
{% link_with_intro /getting-started-with-github-pages %}
{% link_with_intro /setting-up-a-github-pages-site-with-jekyll %}
{% link_with_intro /configuring-a-custom-domain-for-your-github-pages-site %}

Просмотреть файл

@ -17,6 +17,7 @@ redirect_from:
- /articles/using-jekyll-plugins-with-github-pages/
- /articles/adding-jekyll-plugins-to-a-github-pages-site/
- /articles/about-github-pages-and-jekyll
- /github/working-with-github-pages/about-github-pages-and-jekyll
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'

Просмотреть файл

@ -5,6 +5,7 @@ redirect_from:
- /articles/viewing-jekyll-build-error-messages/
- /articles/generic-jekyll-build-failures/
- /articles/about-jekyll-build-errors-for-github-pages-sites
- /github/working-with-github-pages/about-jekyll-build-errors-for-github-pages-sites
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'

Просмотреть файл

@ -5,6 +5,7 @@ redirect_from:
- /articles/customizing-css-and-html-in-your-jekyll-theme/
- /articles/adding-a-jekyll-theme-to-your-github-pages-site/
- /articles/adding-a-theme-to-your-github-pages-site-using-jekyll
- /github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-using-jekyll
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'

Просмотреть файл

@ -4,6 +4,7 @@ intro: 'You can add a new page or post to your Jekyll site on {% data variables.
product: '{% data reusables.gated-features.pages %}'
redirect_from:
- /articles/adding-content-to-your-github-pages-site-using-jekyll
- /github/working-with-github-pages/adding-content-to-your-github-pages-site-using-jekyll
versions:
free-pro-team: '*'
enterprise-server: '*'

Просмотреть файл

@ -4,6 +4,7 @@ intro: 'You can use Jekyll to create a {% data variables.product.prodname_pages
product: '{% data reusables.gated-features.pages %}'
redirect_from:
- /articles/creating-a-github-pages-site-with-jekyll
- /github/working-with-github-pages/creating-a-github-pages-site-with-jekyll
permissions: 'People with admin permissions for a repository can create a {% data variables.product.prodname_pages %} site with Jekyll.'
versions:
free-pro-team: '*'

Просмотреть файл

@ -0,0 +1,25 @@
---
title: Setting up a GitHub Pages site with Jekyll
intro: 'You can use Jekyll, a popular static site generator, to further customize your {% data variables.product.prodname_pages %} site.'
redirect_from:
- /articles/using-jekyll-with-pages/
- /articles/using-jekyll-as-a-static-site-generator-with-github-pages
- /articles/setting-up-a-github-pages-site-with-jekyll
- /github/working-with-github-pages/setting-up-a-github-pages-site-with-jekyll
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
topics:
- pages
---
{% link_in_list /about-github-pages-and-jekyll %}
{% link_in_list /creating-a-github-pages-site-with-jekyll %}
{% link_in_list /testing-your-github-pages-site-locally-with-jekyll %}
{% link_in_list /adding-content-to-your-github-pages-site-using-jekyll %}
{% link_in_list /setting-a-markdown-processor-for-your-github-pages-site-using-jekyll %}
{% link_in_list /adding-a-theme-to-your-github-pages-site-using-jekyll %}
{% link_in_list /about-jekyll-build-errors-for-github-pages-sites %}
{% link_in_list /troubleshooting-jekyll-build-errors-for-github-pages-sites %}

Просмотреть файл

@ -5,6 +5,7 @@ redirect_from:
- /articles/migrating-your-pages-site-from-maruku/
- /articles/updating-your-markdown-processor-to-kramdown/
- /articles/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll
- /github/working-with-github-pages/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'

Просмотреть файл

@ -5,6 +5,7 @@ redirect_from:
- /articles/setting-up-your-pages-site-locally-with-jekyll/
- /articles/setting-up-your-github-pages-site-locally-with-jekyll/
- /articles/testing-your-github-pages-site-locally-with-jekyll
- /github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'

Просмотреть файл

@ -24,6 +24,7 @@ redirect_from:
- /articles/troubleshooting-github-pages-builds/
- /articles/troubleshooting-jekyll-builds/
- /articles/troubleshooting-jekyll-build-errors-for-github-pages-sites
- /github/working-with-github-pages/troubleshooting-jekyll-build-errors-for-github-pages-sites
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'

Просмотреть файл

@ -200,7 +200,7 @@ The authenticated user will be the author of any merges done through this endpoi
## Pages
The {% data variables.product.prodname_pages %} API retrieves information about your {% data variables.product.prodname_pages %} configuration, and the statuses of your builds. Information about the site and the builds can only be accessed by authenticated owners{% if currentVersion != "github-ae@latest" %}, even if the websites are public{% endif %}. For more information, see "[About {% data variables.product.prodname_pages %}](/github/working-with-github-pages/about-github-pages)."
The {% data variables.product.prodname_pages %} API retrieves information about your {% data variables.product.prodname_pages %} configuration, and the statuses of your builds. Information about the site and the builds can only be accessed by authenticated owners{% if currentVersion != "github-ae@latest" %}, even if the websites are public{% endif %}. For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)."
In {% data variables.product.prodname_pages %} API endpoints with a `status` key in their response, the value can be one of:
* `null`: The site has yet to be built.
@ -212,7 +212,7 @@ In {% data variables.product.prodname_pages %} API endpoints with a `status` key
In {% data variables.product.prodname_pages %} API endpoints that return GitHub Pages site information, the JSON responses include these fields:
* `html_url`: The absolute URL (including scheme) of the rendered Pages site. For example, `https://username.github.io`.
* `source`: An object that contains the source branch and directory for the rendered Pages site. This includes:
- `branch`: The repository branch used to publish your [site's source files](/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site). For example, _main_ or _gh-pages_.
- `branch`: The repository branch used to publish your [site's source files](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site). For example, _main_ or _gh-pages_.
- `path`: The repository directory from which the site publishes. Will be either `/` or `/docs`.
{% for operation in currentRestOperations %}

Просмотреть файл

@ -13,5 +13,6 @@ productsInOrder:
- graphql
- insights
- communities
- pages
- education
- desktop

Просмотреть файл

@ -1,2 +1,2 @@
1. Optionally, if you're publishing a project site from a private or internal repository owned by an organization using {% data variables.product.prodname_ghe_cloud %}, choose the visibility for your site. Under "{% data variables.product.prodname_pages %}", select the **{% data variables.product.prodname_pages %} visibility** drop-down menu, then click a visibility. For more information, see "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/changing-the-visibility-of-your-github-pages-site)".
1. Optionally, if you're publishing a project site from a private or internal repository owned by an organization using {% data variables.product.prodname_ghe_cloud %}, choose the visibility for your site. Under "{% data variables.product.prodname_pages %}", select the **{% data variables.product.prodname_pages %} visibility** drop-down menu, then click a visibility. For more information, see "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)".
![Drop-down to select visibility for your site](/assets/images/help/pages/public-or-private-visibility.png)

Просмотреть файл

@ -1,5 +1,5 @@
{% warning %}
**Warning**: {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}If your site administrator has enabled Public Pages, {% endif %}{% data variables.product.prodname_pages %} sites are publicly available on the internet{% if currentVersion == "free-pro-team@latest" %} by default{% endif %}, even if the repository for the site is private or internal.{% if currentVersion == "free-pro-team@latest" %} {% data reusables.pages.about-private-publishing %} Otherwise, if{% else %} If{% endif %} you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} "[Configuring {% data variables.product.prodname_pages %} for your enterprise](/admin/configuration/configuring-github-pages-for-your-enterprise#enabling-public-sites-for-github-pages)" and{% endif %} "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility){% if currentVersion == "free-pro-team@latest" %}" and "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/changing-the-visibility-of-your-github-pages-site)."{% else %}."{% endif %}
**Warning**: {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}If your site administrator has enabled Public Pages, {% endif %}{% data variables.product.prodname_pages %} sites are publicly available on the internet{% if currentVersion == "free-pro-team@latest" %} by default{% endif %}, even if the repository for the site is private or internal.{% if currentVersion == "free-pro-team@latest" %} {% data reusables.pages.about-private-publishing %} Otherwise, if{% else %} If{% endif %} you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} "[Configuring {% data variables.product.prodname_pages %} for your enterprise](/admin/configuration/configuring-github-pages-for-your-enterprise#enabling-public-sites-for-github-pages)" and{% endif %} "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility){% if currentVersion == "free-pro-team@latest" %}" and "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)."{% else %}."{% endif %}
{% endwarning %}

Просмотреть файл

@ -1 +1 @@
{% if currentVersion == "free-pro-team@latest" %}1. If there's a custom domain enabled for your site, to avoid a domain takeover, update your DNS settings. For more information, see "[Configuring a custom domain for your {% data variables.product.prodname_pages %} site](/articles/configuring-a-custom-domain-for-your-github-pages-site)."{% endif %}
{% if currentVersion == "free-pro-team@latest" %}1. If there's a custom domain enabled for your site, to avoid a domain takeover, update your DNS settings. For more information, see "[Configuring a custom domain for your {% data variables.product.prodname_pages %} site](/pages/configuring-a-custom-domain-for-your-github-pages-site)."{% endif %}

Просмотреть файл

@ -1 +1 @@
If you are using an apex domain as your custom domain, we recommend also setting up a `www` subdomain. If you configure the correct records for each domain type through your DNS provider, {% data variables.product.prodname_pages %} will automatically create redirects between the domains. For example, if you configure `www.example.com` as the custom domain for your site, and you have {% data variables.product.prodname_pages %} DNS records set up for the apex and `www` domains, then `example.com` will redirect to `www.example.com`. Note that automatic redirects only apply to the `www` subdomain. Automatic redirects do not apply to any other subdomains, such as `blog`.
If you are using an apex domain as your custom domain, we recommend also setting up a `www` subdomain. If you configure the correct records for each domain type through your DNS provider, {% data variables.product.prodname_pages %} will automatically create redirects between the domains. For example, if you configure `www.example.com` as the custom domain for your site, and you have {% data variables.product.prodname_pages %} DNS records set up for the apex and `www` domains, then `example.com` will redirect to `www.example.com`. Note that automatic redirects only apply to the `www` subdomain. Automatic redirects do not apply to any other subdomains, such as `blog`.

Просмотреть файл

@ -215,7 +215,7 @@ describe('server', () => {
})
test('preserves liquid statements with liquid raw tags in page output', async () => {
const $ = await getDOM('/en/github/working-with-github-pages/troubleshooting-jekyll-build-errors-for-github-pages-sites')
const $ = await getDOM('/en/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites')
expect($.text().includes('{{ page.title }}')).toBe(true)
})