Reusable clarifying Actions is fully supported while Jekyll is not (#39148)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>
This commit is contained in:
@@ -28,6 +28,8 @@ topics:
|
||||
shortTitle: GitHub Pages & Jekyll
|
||||
---
|
||||
|
||||
{% data reusables.pages.actions-is-preferred %}
|
||||
|
||||
## About Jekyll
|
||||
|
||||
Jekyll is a static site generator with built-in support for {% data variables.product.prodname_pages %} and a simplified build process. Jekyll takes Markdown and HTML files and creates a complete static website based on your choice of layouts. Jekyll supports Markdown and Liquid, a templating language that loads dynamic content on your site. For more information, see [Jekyll](https://jekyllrb.com/).
|
||||
|
||||
@@ -16,6 +16,8 @@ topics:
|
||||
shortTitle: Jekyll build errors for Pages
|
||||
---
|
||||
|
||||
{% data reusables.pages.actions-is-preferred %}
|
||||
|
||||
## About Jekyll build errors
|
||||
|
||||
If you are publishing from a branch, sometimes {% data variables.product.prodname_pages %} will not attempt to build your site after you push changes to your site's publishing source.{% ifversion fpt or ghec %}
|
||||
|
||||
@@ -17,6 +17,8 @@ topics:
|
||||
shortTitle: Add theme to Pages site
|
||||
---
|
||||
|
||||
{% data reusables.pages.actions-is-preferred %}
|
||||
|
||||
People with write permissions for a repository can add a theme to a {% data variables.product.prodname_pages %} site using Jekyll.
|
||||
|
||||
{% data reusables.pages.test-locally %}
|
||||
|
||||
@@ -14,6 +14,8 @@ topics:
|
||||
shortTitle: Add content to Pages site
|
||||
---
|
||||
|
||||
{% data reusables.pages.actions-is-preferred %}
|
||||
|
||||
People with write permissions for a repository can add content to a {% data variables.product.prodname_pages %} site using Jekyll.
|
||||
|
||||
## About content in Jekyll sites
|
||||
|
||||
@@ -17,6 +17,8 @@ shortTitle: Create site with Jekyll
|
||||
|
||||
|
||||
|
||||
{% data reusables.pages.actions-is-preferred %}
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before you can use Jekyll to create a {% data variables.product.prodname_pages %} site, you must install Jekyll and Git. For more information, see [Installation](https://jekyllrb.com/docs/installation/) in the Jekyll documentation and [AUTOTITLE](/get-started/git-basics/set-up-git).
|
||||
|
||||
@@ -16,6 +16,8 @@ topics:
|
||||
shortTitle: Set Markdown processor
|
||||
---
|
||||
|
||||
{% data reusables.pages.actions-is-preferred %}
|
||||
|
||||
People with write permissions for a repository can set the Markdown processor for a {% data variables.product.prodname_pages %} site.
|
||||
|
||||
{% data variables.product.prodname_pages %} supports two Markdown processors: [kramdown](http://kramdown.gettalong.org/) and {% data variables.product.github %}'s own Markdown processor, which is used to render [{% data variables.product.prodname_dotcom %} Flavored Markdown (GFM)](https://github.github.com/gfm/) throughout {% data variables.product.github %}. For more information, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github).
|
||||
|
||||
@@ -64,6 +64,8 @@ Before you can use Jekyll to test a site, you must:
|
||||
|
||||
## Updating the {% data variables.product.prodname_pages %} gem
|
||||
|
||||
{% data reusables.pages.actions-is-preferred %}
|
||||
|
||||
Jekyll is an active open source project that is updated frequently. If the `github-pages` gem on your computer is out of date with the `github-pages` gem on the {% data variables.product.prodname_pages %} server, your site may look different when built locally than when published on {% data variables.product.github %}. To avoid this, regularly update the `github-pages` gem on your computer.
|
||||
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
|
||||
@@ -1,3 +1 @@
|
||||
{% data variables.product.prodname_pages %} is available in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}. {% ifversion fpt or ghec %}{% data reusables.gated-features.more-info %}{% endif %}
|
||||
|
||||
{% ifversion fpt or ghec %}{% data variables.product.prodname_pages %} now uses {% data variables.product.prodname_actions %} to execute the Jekyll build. When using a branch as the source of your build, {% data variables.product.prodname_actions %} must be enabled in your repository if you want to use the built-in Jekyll workflow. Alternatively, if {% data variables.product.prodname_actions %} is unavailable or disabled, adding a `.nojekyll` file to the root of your source branch will bypass the Jekyll build process and deploy the content directly. For more information on enabling {% data variables.product.prodname_actions %}, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository).{% endif %}
|
||||
|
||||
1
data/reusables/pages/actions-is-preferred.md
Normal file
1
data/reusables/pages/actions-is-preferred.md
Normal file
@@ -0,0 +1 @@
|
||||
> [!NOTE] While this `github-pages` gem remains supported for some workflows, {% data variables.product.prodname_actions %} is now the recommended approach for deploying and automating {% data variables.product.prodname_pages %} sites.
|
||||
Reference in New Issue
Block a user