glowz/skills-github-pages
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Update to 5 in STEP and README.md

Browse Source
This commit is contained in:
github-actions[bot] 2024-10-23 07:53:00 +00:00
parent 72053998d3
commit 7659607f76
2 changed files with 8 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/steps/-step.txt vendored
View File

@ -1 +1 @@
4
5

41
README.md
View File

@ -14,48 +14,21 @@ _Create a site or blog from your GitHub repositories with GitHub Pages._
</header>
<!--
<<< Author notes: Step 4 >>>
<<< Author notes: Step 5 >>>
Start this step by acknowledging the previous step.
Define terms and link to docs.github.com.
Historic note: previous version checked the file path. Previous version checked the front matter formatting.
-->
## Step 4: Create a blog post
## Step 5: Merge your pull request
_Your home page is looking great! :cowboy_hat_face:_
_Nice work, friend :heart:! People will be reading your blog in no time!_
GitHub Pages uses Jekyll. In Jekyll, we can create a blog by using specially named files and frontmatter. The files must be named `_posts/YYYY-MM-DD-title.md`. You must also include `title` and `date` in your frontmatter.
You can now [merge](https://docs.github.com/en/get-started/quickstart/github-glossary#merge) your pull request!
**What is _frontmatter_?**: The syntax Jekyll files use is called YAML frontmatter. It goes at the top of your file and looks something like this:
### :keyboard: Activity: Merge your changes
```yml
---
title: "Welcome to my blog"
date: 2019-01-20
---
```
For more information about configuring front matter, see the [Jekyll frontmatter documentation](https://jekyllrb.com/docs/frontmatter/).
### :keyboard: Activity: Create a blog post
1. Browse to the `my-pages` branch.
1. Click the `Add file` dropdown menu and then on `Create new file`.
1. Name the file `_posts/YYYY-MM-DD-title.md`.
1. Replace the `YYYY-MM-DD` with today's date, and change the `title` of your first blog post if you'd like.
> If you do edit the title, make sure there are hyphens between your words.
> If your blog post date doesn't follow the correct date convention, you'll receive an error and your site won't build. For more information, see "[Page build failed: Invalid post date](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites)".
1. Type the following content at the top of your blog post:
```yaml
---
title: "YOUR-TITLE"
date: YYYY-MM-DD
---
```
1. Replace `YOUR-TITLE` with the title for your blog post.
1. Replace `YYYY-MM-DD` with today's date.
1. Type a quick draft of your blog post. Remember, you can always edit it later.
1. Commit your changes to your branch.
1. Merge your changes from `my-pages` into `main`. If you created the pull request in step 2, just open that PR and click on **Merge pull request**. If you did not create the pull request earlier, you can do it now by following the instructions in [step 2](/.github/steps/2-configure-your-site.md).
1. (optional) Delete the branch `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>