fbc83618dd
* 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
74 lines
3.1 KiB
Markdown
74 lines
3.1 KiB
Markdown
---
|
|
title: Adding a theme to your GitHub Pages site using Jekyll
|
|
intro: You can personalize your Jekyll site by adding and customizing a theme.
|
|
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: '*'
|
|
enterprise-server: '*'
|
|
github-ae: '*'
|
|
topics:
|
|
- pages
|
|
---
|
|
|
|
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](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site.
|
|
|
|
- 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.
|
|
|
|
{% 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:
|
|
```scss
|
|
---
|
|
---
|
|
|
|
@import "{{ site.theme }}";
|
|
```
|
|
3. 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 %}
|
|
6. Create a file called *_layouts/default.html*.
|
|
7. Paste the default layout content you copied earlier.
|
|
8. Customize the layout as you'd like.
|
|
|
|
### Further reading
|
|
|
|
- "[Creating new files](/articles/creating-new-files)"
|