1
0
mirror of synced 2025-12-21 10:57:10 -05:00
Files
docs/content/github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-using-jekyll.md
Sarah Schneider f272eec944 Remove deprecated GHES versions from content and data (#15830)
* ran script/remove-unused-assets.js (manually removed unused variables printed by the script)

* package-lock

* turn elsif into two ifs to prepare for running Liquid deprecation script

* ran script/remove-deprecated-enterprise-version-markup.js --release 2.14 (ONLY UPDATES LINE BREAKS ETC.)

* ran script/remove-deprecated-enterprise-version-markup.js --release 2.15

* ran script/remove-deprecated-enterprise-version-markup.js --release 2.17

* ran script/remove-deprecated-enterprise-version-markup.js --release 2.18

* update hardcoded test

* Update content/github/collaborating-with-issues-and-pull-requests/filtering-files-in-a-pull-request.md

Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>

* add currentVersion is NOT free-pro-team to conditional, to make sure the deprecation script does the right thing when it is time to deprecate 2.21

Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
2020-10-01 10:55:34 -04:00

3.0 KiB

title, intro, redirect_from, product, versions
title intro redirect_from product versions
Adding a theme to your GitHub Pages site using Jekyll You can personalize your Jekyll site by adding and customizing a theme.
/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
{% data reusables.gated-features.pages %}
free-pro-team enterprise-server
* *

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 %}

Adding a theme

{% data reusables.pages.navigate-site-repo %} {% data reusables.pages.navigate-publishing-source %} 2. Navigate to _config.yml. {% data reusables.repositories.edit-file %} 4. Add a new line to the file for the theme name.

  • To use a supported theme, type theme: THEME-NAME, replacing THEME-NAME with the name of the theme as shown in the README of the theme's repository. For a list of supported themes, see "Supported themes" on the {% data variables.product.prodname_pages %} site. Supported theme in config file
  • To use any other Jekyll theme hosted on {% data variables.product.prodname_dotcom %}, type remote_theme: THEME-NAME, replacing THEME-NAME with the name of the theme as shown in the README of the theme's repository. Unsupported theme in config file {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_file_change %}

Customizing your theme's CSS

{% data reusables.pages.best-with-supported-themes %}

{% data reusables.pages.theme-customization-help %}

{% data reusables.pages.navigate-site-repo %} {% data reusables.pages.navigate-publishing-source %}

  1. Create a new file called /assets/css/style.scss.
  2. Add the following content to the top of the file:
---
---

@import "{{ site.theme }}";
  1. Add any custom CSS or Sass (including imports) you'd like immediately after the @import line.

Customizing your theme's HTML layout

{% data reusables.pages.best-with-supported-themes %}

{% data reusables.pages.theme-customization-help %}

  1. On {% data variables.product.prodname_dotcom %}, navigate to your theme's source repository. For example, the source repository for Minima is https://github.com/jekyll/minima.
  2. In the _layouts folder, navigate to your theme's default.html file.
  3. Copy the contents of the file. {% data reusables.pages.navigate-site-repo %} {% data reusables.pages.navigate-publishing-source %}
  4. Create a file called _layouts/default.html.
  5. Paste the default layout content you copied earlier.
  6. Customize the layout as you'd like.

Further reading