skills-github-pages/README.md

60 lines
2.4 KiB
Markdown
Raw Normal View History

2024-10-23 15:33:27 +08:00
<header>
<!--
<<< Author notes: Course header >>>
Include a 1280×640 image, course title in sentence case, and a concise description in emphasis.
In your repository settings: enable template repository, add your 1280×640 social image, auto delete head branches.
Add your open source license, GitHub uses MIT license.
-->
# GitHub Pages
_Create a site or blog from your GitHub repositories with GitHub Pages._
</header>
<!--
2024-10-23 15:46:21 +08:00
<<< Author notes: Step 2 >>>
Start this step by acknowledging the previous step.
Define terms and link to docs.github.com.
Historic note: previous version checked for empty pull request, changed to the correct theme `minima`.
2024-10-23 15:33:27 +08:00
-->
2024-10-23 15:46:21 +08:00
## Step 2: Configure your site
2024-10-23 15:33:27 +08:00
2024-10-23 15:46:21 +08:00
_You turned on GitHub Pages! :tada:_
2024-10-23 15:33:27 +08:00
2024-10-23 15:46:21 +08:00
We'll work in a branch, `my-pages`, that I created for you to get this site looking great. :sparkle:
2024-10-23 15:33:27 +08:00
2024-10-23 15:46:21 +08:00
Jekyll uses a file titled `_config.yml` to store settings for your site, your theme, and reusable content like your site title and GitHub handle. You can check out the `_config.yml` file on the **Code** tab of your repository.
2024-10-23 15:33:27 +08:00
2024-10-23 15:46:21 +08:00
We need to use a blog-ready theme. For this activity, we will use a theme named "minima".
### :keyboard: Activity: Configure your site
1. Browse to the `_config.yml` file in the `my-pages` branch.
1. In the upper right corner, open the file editor.
1. Add a `theme:` set to **minima** so it shows in the `_config.yml` file as below:
```yml
theme: minima
```
1. (optional) You can modify the other configuration variables such as `title:`, `author:`, and `description:` to further customize your site.
1. Commit your changes.
1. (optional) Create a pull request to view all the changes you'll make throughout this course. Click the **Pull Requests** tab, click **New pull request**, set `base: main` and `compare:my-pages`.
1. Wait about 20 seconds then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/en/actions) will automatically update to the next step.
2024-10-23 15:33:27 +08:00
<footer>
<!--
<<< Author notes: Footer >>>
Add a link to get support, GitHub status page, code of conduct, license link.
-->
---
Get help: [Post in our discussion board](https://github.com/orgs/skills/discussions/categories/github-pages) &bull; [Review the GitHub status page](https://www.githubstatus.com/)
&copy; 2023 GitHub &bull; [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) &bull; [MIT License](https://gh.io/mit)
</footer>