Update to 2 in STEP and README.md
This commit is contained in:
parent
472e522b03
commit
95d2b8d083
2
.github/steps/-step.txt
vendored
2
.github/steps/-step.txt
vendored
@ -1 +1 @@
|
|||||||
1
|
2
|
||||||
|
39
README.md
39
README.md
@ -14,29 +14,34 @@ _Create a site or blog from your GitHub repositories with GitHub Pages._
|
|||||||
</header>
|
</header>
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
<<< Author notes: Step 1 >>>
|
<<< Author notes: Step 2 >>>
|
||||||
Choose 3-5 steps for your course.
|
Start this step by acknowledging the previous step.
|
||||||
The first step is always the hardest, so pick something easy!
|
Define terms and link to docs.github.com.
|
||||||
Link to docs.github.com for further explanations.
|
Historic note: previous version checked for empty pull request, changed to the correct theme `minima`.
|
||||||
Encourage users to open new tabs for steps!
|
|
||||||
-->
|
-->
|
||||||
|
|
||||||
## Step 1: Enable GitHub Pages
|
## Step 2: Configure your site
|
||||||
|
|
||||||
_Welcome to GitHub Pages and Jekyll :tada:!_
|
_You turned on GitHub Pages! :tada:_
|
||||||
|
|
||||||
The first step is to enable GitHub Pages on this [repository](https://docs.github.com/en/get-started/quickstart/github-glossary#repository). When you enable GitHub Pages on a repository, GitHub takes the content that's on the main branch and publishes a website based on its contents.
|
We'll work in a branch, `my-pages`, that I created for you to get this site looking great. :sparkle:
|
||||||
|
|
||||||
### :keyboard: Activity: Enable GitHub Pages
|
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.
|
||||||
|
|
||||||
1. Open a new browser tab, and work on the steps in your second tab while you read the instructions in this tab.
|
We need to use a blog-ready theme. For this activity, we will use a theme named "minima".
|
||||||
1. Under your repository name, click **Settings**.
|
|
||||||
1. Click **Pages** in the **Code and automation** section.
|
### :keyboard: Activity: Configure your site
|
||||||
1. Ensure "Deploy from a branch" is selected from the **Source** drop-down menu, and then select `main` from the **Branch** drop-down menu.
|
|
||||||
1. Click the **Save** button.
|
1. Browse to the `_config.yml` file in the `my-pages` branch.
|
||||||
1. Wait about _one minute_ 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.
|
1. In the upper right corner, open the file editor.
|
||||||
> Turning on GitHub Pages creates a deployment of your repository. GitHub Actions may take up to a minute to respond while waiting for the deployment. Future steps will be about 20 seconds; this step is slower.
|
1. Add a `theme:` set to **minima** so it shows in the `_config.yml` file as below:
|
||||||
> **Note**: In the **Pages** of **Settings**, the **Visit site** button will appear at the top. Click the button to see your GitHub Pages site.
|
```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.
|
||||||
|
|
||||||
<footer>
|
<footer>
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user