Skip to content

Reusable clarifying Actions is fully supported while Jekyll is not #39148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@
ghec: '*'
topics:
- Pages
shortTitle: Jekyll build errors for Pages

Check warning on line 16 in content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md

View workflow job for this annotation

GitHub Actions / lint-content

Frontmatter properties must meet character limits and required property requirements

ShortTitle exceeds recommended length of 25 characters (current: 29).
---

{% 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 %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Setting a Markdown processor for your GitHub Pages site using Jekyll

Check warning on line 2 in content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md

View workflow job for this annotation

GitHub Actions / lint-content

Frontmatter properties must meet character limits and required property requirements

Title exceeds recommended length of 60 characters (current: 68).
intro: 'You can choose a Markdown processor to determine how Markdown is rendered on your {% data variables.product.prodname_pages %} site.'
redirect_from:
- /articles/migrating-your-pages-site-from-maruku
Expand All @@ -16,6 +16,8 @@
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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@
ghec: '*'
topics:
- Pages
shortTitle: Test site locally with Jekyll

Check warning on line 16 in content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md

View workflow job for this annotation

GitHub Actions / lint-content

Frontmatter properties must meet character limits and required property requirements

ShortTitle exceeds recommended length of 25 characters (current: 29).
---

{% data reusables.pages.actions-is-preferred %}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this information about using Actions for Pages is relevant for local testing. It might be helpful context specifically for github-pages gem content.

Suggestion: move this reusable to the ## Updating the {% data variables.product.prodname_pages %} gem section of this article instead of at the top.


Anyone with read permissions for a repository can test a {% data variables.product.prodname_pages %} site locally.

## Prerequisites
Expand Down
2 changes: 0 additions & 2 deletions data/reusables/gated-features/pages.md
Original file line number Diff line number Diff line change
@@ -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 %}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this information exist elsewhere? Based on this conversation, it seems like it's still relevant.

1 change: 1 addition & 0 deletions data/reusables/pages/actions-is-preferred.md
Original file line number Diff line number Diff line change
@@ -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.
Loading