generated from skills/communicate-using-markdown
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 43de374
Showing
18 changed files
with
791 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
version: 2 | ||
updates: | ||
- package-ecosystem: "github-actions" | ||
directory: "/" | ||
schedule: | ||
interval: "monthly" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
<!-- readme --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
<!-- | ||
<<< Author notes: Step 1 >>> | ||
Choose 3-5 steps for your course. | ||
The first step is always the hardest, so pick something easy! | ||
Link to docs.github.com for further explanations. | ||
Encourage users to open new tabs for steps! | ||
--> | ||
|
||
## Step 1: Add headers | ||
|
||
_Welcome to "Communicate using Markdown"! :wave:_ | ||
|
||
**What is _Markdown_?** Markdown is a [lightweight syntax](https://docs.github.com/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) for communicating on GitHub. You can format text to add a heading, lists, **bold**, _italics_, tables, and many other stylings. You can use Markdown in most places around GitHub: | ||
|
||
- Comments on [issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues), [pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests), and [discussions](https://docs.github.com/discussions/collaborating-with-your-community-using-discussions/about-discussions) | ||
- Files with the `.md` or `.markdown` extension | ||
- Sharing snippets of text in [Gists](https://docs.github.com/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists) | ||
|
||
**What is a _header_?** A header is a larger bit of text at the beginning of a section. There are six sizes. | ||
|
||
### Example | ||
|
||
```md | ||
# This is an `<h1>` header, which is the largest | ||
|
||
## This is an `<h2>` header | ||
|
||
###### This is an `<h6>` header, which is the smallest | ||
``` | ||
|
||
#### How it looks | ||
|
||
# This is an `<h1>` header, which is the largest | ||
|
||
## This is an `<h2>` header | ||
|
||
###### This is an `<h6>` header, which is the smallest | ||
|
||
### :keyboard: Activity: Edit your file with headers | ||
|
||
1. Open a new browser tab, and work on the steps in your second tab while you read the instructions in this tab. | ||
1. Open the **pull requests** tab. | ||
1. Click **New pull request**, for the branches to compare, select `base: main` and `compare: start-markdown`. | ||
1. Click **Create pull request**. | ||
1. In this pull request, go to the **Files changed** tab. We made an empty file `index.md` for you. | ||
1. Select **Edit file** from the three dotted **...** menu in the upper right corner of the file view on `index.md`. | ||
1. On the **Edit file** tab, add a `#`, followed by a **space**, before any content you like to make it an H1 Header. You can add more headers, using one to six `#` characters followed by a **space**. | ||
1. Above your new content, click **Preview**. | ||
1. At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file. | ||
1. Click **Commit changes**. | ||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
<!-- | ||
<<< Author notes: Step 2 >>> | ||
Start this step by acknowledging the previous step. | ||
Define terms and link to docs.github.com. | ||
--> | ||
|
||
## Step 2: Add an image | ||
|
||
_Great job adding headers to the file :sparkles:_ | ||
|
||
Let's add an image. Include descriptive text in the square brackets. This text is read aloud for people using screen readers. It's also shown at times when your image doesn't display, such as when there's a poor connection. You can see the syntax for images below: | ||
|
||
### Example | ||
|
||
```md | ||
![Image of Yaktocat](https://octodex.github.com/images/yaktocat.png) | ||
``` | ||
|
||
#### How it looks | ||
|
||
<img alt="Image of Yaktocat" src=https://octodex.github.com/images/yaktocat.png width=400> | ||
|
||
### :keyboard: Activity: Adding an image | ||
|
||
1. As you did before, edit the `index.md` file in this pull request. | ||
1. In the file, add the correct Markdown for your image of choice. Don't forget to include alt-text! | ||
1. Use the **Preview** tab to check your Markdown formatting. | ||
1. Commit your changes. | ||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
<!-- | ||
<<< Author notes: Step 3 >>> | ||
Start this step by acknowledging the previous step. | ||
Define terms and link to docs.github.com. | ||
--> | ||
|
||
## Step 3: Add a code example | ||
|
||
_Great job adding an image to the file :tada:_ | ||
|
||
Let's add some code blocks. Code blocks can render differently depending on the language. | ||
|
||
### Example 1 | ||
|
||
<pre> | ||
``` | ||
$ git init | ||
Initialized empty Git repository in /Users/skills/Projects/recipe-repository/.git/ | ||
``` | ||
</pre> | ||
|
||
#### How it looks | ||
|
||
``` | ||
$ git init | ||
Initialized empty Git repository in /Users/skills/Projects/recipe-repository/.git/ | ||
``` | ||
|
||
### Example 2 | ||
|
||
<pre> | ||
``` javascript | ||
var myVar = "Hello, world!"; | ||
``` | ||
</pre> | ||
|
||
#### How it looks | ||
|
||
```javascript | ||
var myVar = "Hello, world!"; | ||
``` | ||
|
||
### :keyboard: Activity: Adding a code example | ||
|
||
1. As you did before, edit the file in this pull request. | ||
1. In the file, add the correct Markdown for a code example of your choice. | ||
1. Use the **Preview** tab to check your Markdown formatting. | ||
1. Commit your changes. | ||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
<!-- | ||
<<< Author notes: Step 4 >>> | ||
Start this step by acknowledging the previous step. | ||
Define terms and link to docs.github.com. | ||
--> | ||
|
||
## Step 4: Make a task list | ||
|
||
_Great job adding a code example to the file :partying_face:_ | ||
|
||
**What is a _task list_?** A task list creates checkboxes to check off. They're very useful for tracking issues and pull requests. If you include a task list in the body of an issue or pull request, you'll see a progress indicator in your issue list. The syntax for task lists is very specific. Be sure to include the spaces where required, or else they won't render. | ||
|
||
### Example | ||
|
||
``` | ||
- [x] List syntax is required | ||
- [x] This item is complete | ||
- [ ] This item is not complete | ||
``` | ||
|
||
#### How it looks | ||
|
||
- [x] List syntax is required | ||
- [x] This item is complete | ||
- [ ] This item is not complete | ||
|
||
### :keyboard: Activity: Add a task list | ||
|
||
GitHub Actions went ahead and made a branch for you. So you'll need to add to the file we've created in the branch, and we will check your work as you work through this course! | ||
|
||
1. Return to your pull request. | ||
1. Use Markdown to create a task list. Here is an example: | ||
|
||
```md | ||
- [ ] Turn on GitHub Pages | ||
- [ ] Outline my portfolio | ||
- [ ] Introduce myself to the world | ||
``` | ||
|
||
Remember, a task list starts with the syntax `- [ ]` and then the task list item. The formatting is specific! | ||
|
||
1. Use the **Preview** tab to check your Markdown formatting. | ||
1. Commit the changes to the file. | ||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
<!-- | ||
<<< Author notes: Step 5 >>> | ||
Start this step by acknowledging the previous step. | ||
Define terms and link to docs.github.com. | ||
--> | ||
|
||
## Step 5: Merge your pull request | ||
|
||
_Great job adding a task list to the file :heart:_ | ||
|
||
You can now [merge](https://docs.github.com/get-started/quickstart/github-glossary#merge) your pull request! | ||
|
||
### :keyboard: Activity: Merge your pull request | ||
|
||
1. Click **Merge pull request**. | ||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
<!-- | ||
<<< Author notes: Finish >>> | ||
Review what we learned, ask for feedback, provide next steps. | ||
--> | ||
|
||
## Finish | ||
|
||
_Congratulations friend, you've completed this course!_ | ||
|
||
<img src=https://octodex.github.com/images/welcometocat.png alt=celebrate width=300 align=right> | ||
|
||
Here's a recap of all the tasks you've accomplished in your repository: | ||
|
||
1. You learned about Markdown, headings, images, code examples, and task lists. | ||
1. You created and merged a Markdown file. | ||
1. You learned an essential GitHub skill. 🎉 | ||
|
||
### What's next? | ||
|
||
- You can enable GitHub Pages and see your Markdown file as a website! | ||
1. Under your repository name at the upper right, click :gear: **Settings**. | ||
1. Then on the lower left, click **Pages** in the **Code and automation** section. | ||
1. In the **GitHub Pages** section, ensure "Deploy from a branch" is selected from the **Source** drop-down menu, and then select `main` from the **Branch** drop-down menu as your GitHub Pages publishing source. | ||
1. Click the **Save** button. | ||
1. Wait about 30 seconds then refresh the page. When you see "Your site is published at ..." you can click on the link to see your published site. | ||
- Learn more about [Markdown](https://docs.github.com/github/writing-on-github). | ||
- We'd love to hear what you thought of this course [in our discussion board](https://github.com/orgs/skills/discussions/categories/communicate-using-markdown) | ||
- [Take another GitHub Skills course](https://github.com/skills). | ||
- [Read the GitHub Getting Started docs](https://docs.github.com/get-started). | ||
- To find projects to contribute to, check out [GitHub Explore](https://github.com/explore). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
name: Step 0, Welcome | ||
|
||
# This step triggers after the learner creates a new repository from the template. | ||
# This workflow updates from step 0 to step 1. | ||
|
||
# This will run every time we create push a commit to `main`. | ||
# Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows | ||
on: | ||
workflow_dispatch: | ||
push: | ||
branches: | ||
- main | ||
|
||
# Reference: https://docs.github.com/en/actions/security-guides/automatic-token-authentication | ||
permissions: | ||
# Need `contents: read` to checkout the repository. | ||
# Need `contents: write` to update the step metadata. | ||
# Need `pull-requests: write` to create a pull request. | ||
contents: write | ||
pull-requests: write | ||
|
||
jobs: | ||
# Get the current step to only run the main job when the learner is on the same step. | ||
get_current_step: | ||
name: Check current step number | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
- id: get_step | ||
run: | | ||
echo "current_step=$(cat ./.github/steps/-step.txt)" >> $GITHUB_OUTPUT | ||
outputs: | ||
current_step: ${{ steps.get_step.outputs.current_step }} | ||
|
||
on_start: | ||
name: On start | ||
needs: get_current_step | ||
|
||
# We will only run this action when: | ||
# 1. This repository isn't the template repository. | ||
# 2. The step is currently 0. | ||
# Reference: https://docs.github.com/en/actions/learn-github-actions/contexts | ||
# Reference: https://docs.github.com/en/actions/learn-github-actions/expressions | ||
if: >- | ||
${{ !github.event.repository.is_template | ||
&& needs.get_current_step.outputs.current_step == 0 }} | ||
# We'll run Ubuntu for performance instead of Mac or Windows. | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
# We'll need to check out the repository so that we can edit the README. | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 # Let's get all the branches. | ||
|
||
# Make a branch, file, commit, and pull request for the learner. | ||
- name: Prepare a pull request, branch, and file | ||
run: | | ||
echo "Make sure we are on step 0" | ||
if [ "$(cat .github/steps/-step.txt)" != 0 ] | ||
then | ||
echo "Current step is not 0" | ||
exit 0 | ||
fi | ||
echo "Make a branch" | ||
BRANCH=start-markdown | ||
git checkout -b $BRANCH | ||
echo "Make a file" | ||
touch index.md | ||
echo "Make a commit" | ||
git config user.name github-actions[bot] | ||
git config user.email github-actions[bot]@users.noreply.github.com | ||
git add index.md | ||
git commit --message="Create index.md file" | ||
echo "Push" | ||
git push --set-upstream origin $BRANCH | ||
echo "Restore main" | ||
git checkout main | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
||
# In README.md, switch step 0 for step 1. | ||
- name: Update to step 1 | ||
uses: skills/action-update-step@v2 | ||
with: | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
from_step: 0 | ||
to_step: 1 | ||
branch_name: start-markdown |
Oops, something went wrong.