├── .github ├── dependabot.yml ├── steps │ ├── -step.txt │ ├── 0-welcome.md │ ├── 1-add-headers.md │ ├── 2-add-an-image.md │ ├── 3-add-a-code-example.md │ ├── 4-make-a-task-list.md │ ├── 5-merge-your-pull-request.md │ └── X-finish.md └── workflows │ ├── 0-welcome.yml │ ├── 1-add-headers.yml │ ├── 2-add-an-image.yml │ ├── 3-add-a-code-example.yml │ ├── 4-make-a-task-list.yml │ └── 5-merge-your-pull-request.yml ├── .gitignore ├── LICENSE ├── README.md └── index.md /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: "github-actions" 4 | directory: "/" 5 | schedule: 6 | interval: "monthly" 7 | -------------------------------------------------------------------------------- /.github/steps/-step.txt: -------------------------------------------------------------------------------- 1 | X 2 | -------------------------------------------------------------------------------- /.github/steps/0-welcome.md: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /.github/steps/1-add-headers.md: -------------------------------------------------------------------------------- 1 | 8 | 9 | ## Step 1: Add headers 10 | 11 | _Welcome to "Communicate using Markdown"! :wave:_ 12 | 13 | **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: 14 | 15 | - 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) 16 | - Files with the `.md` or `.markdown` extension 17 | - Sharing snippets of text in [Gists](https://docs.github.com/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists) 18 | 19 | **What is a _header_?** A header is a larger bit of text at the beginning of a section. There are six sizes. 20 | 21 | ### Example 22 | 23 | ```md 24 | # This is an `

` header, which is the largest 25 | 26 | ## This is an `

` header 27 | 28 | ###### This is an `

` header, which is the smallest 29 | ``` 30 | 31 | #### How it looks 32 | 33 | # This is an `

` header, which is the largest 34 | 35 | ## This is an `

` header 36 | 37 | ###### This is an `

` header, which is the smallest 38 | 39 | ### :keyboard: Activity: Edit your file with headers 40 | 41 | 1. Open a new browser tab, and work on the steps in your second tab while you read the instructions in this tab. 42 | 1. Open the **pull requests** tab. 43 | 1. Click **New pull request**, for the branches to compare, select `base: main` and `compare: start-markdown`. 44 | 1. Click **Create pull request**. 45 | 1. In this pull request, go to the **Files changed** tab. We made an empty file `index.md` for you. 46 | 1. Select **Edit file** from the three dotted **...** menu in the upper right corner of the file view on `index.md`. 47 | 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**. 48 | 1. Above your new content, click **Preview**. 49 | 1. At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file. 50 | 1. Click **Commit changes**. 51 | 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. 52 | -------------------------------------------------------------------------------- /.github/steps/2-add-an-image.md: -------------------------------------------------------------------------------- 1 | 6 | 7 | ## Step 2: Add an image 8 | 9 | _Great job adding headers to the file :sparkles:_ 10 | 11 | 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: 12 | 13 | ### Example 14 | 15 | ```md 16 | ![Image of Yaktocat](https://octodex.github.com/images/yaktocat.png) 17 | ``` 18 | 19 | #### How it looks 20 | 21 | Image of Yaktocat 22 | 23 | ### :keyboard: Activity: Adding an image 24 | 25 | 1. As you did before, edit the `index.md` file in this pull request. 26 | 1. In the file, add the correct Markdown for your image of choice. Don't forget to include alt-text! 27 | 1. Use the **Preview** tab to check your Markdown formatting. 28 | 1. Commit your changes. 29 | 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. 30 | -------------------------------------------------------------------------------- /.github/steps/3-add-a-code-example.md: -------------------------------------------------------------------------------- 1 | 6 | 7 | ## Step 3: Add a code example 8 | 9 | _Great job adding an image to the file :tada:_ 10 | 11 | In addition to code blocks, some code blocks should be rendered differently depending on the language, such as JavaScript or command-line text. 12 | 13 | ### Example 1 14 | 15 | 
16 | ```
17 | $ git init
18 | Initialized empty Git repository in /Users/skills/Projects/recipe-repository/.git/
19 | ```
20 |
21 | 22 | #### How it looks 23 | 24 | ``` 25 | $ git init 26 | Initialized empty Git repository in /Users/skills/Projects/recipe-repository/.git/ 27 | ``` 28 | 29 | ### Example 2 30 | 31 | 
32 | ``` javascript
33 | var myVar = "Hello, world!";
34 | ```
35 |
36 | 37 | #### How it looks 38 | 39 | ```javascript 40 | var myVar = "Hello, world!"; 41 | ``` 42 | 43 | ### :keyboard: Activity: Adding a code example 44 | 45 | 1. As you did before, edit the file in this pull request. 46 | 1. In the file, add the correct Markdown for a code example of your choice. 47 | 1. Use the **Preview** tab to check your Markdown formatting. 48 | 1. Commit your changes. 49 | 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. 50 | -------------------------------------------------------------------------------- /.github/steps/4-make-a-task-list.md: -------------------------------------------------------------------------------- 1 | 6 | 7 | ## Step 4: Make a task list 8 | 9 | _Great job adding a code example to the file :partying_face:_ 10 | 11 | **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. 12 | 13 | ### Example 14 | 15 | ``` 16 | - [x] List syntax is required 17 | - [x] This item is complete 18 | - [ ] This item is not complete 19 | ``` 20 | 21 | #### How it looks 22 | 23 | - [x] List syntax is required 24 | - [x] This item is complete 25 | - [ ] This item is not complete 26 | 27 | ### :keyboard: Activity: Add a task list 28 | 29 | 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! 30 | 31 | 1. Return to your pull request. 32 | 1. Use Markdown to create a task list. Here is an example: 33 | 34 | ```md 35 | - [ ] Turn on GitHub Pages 36 | - [ ] Outline my portfolio 37 | - [ ] Introduce myself to the world 38 | ``` 39 | 40 | Remember, a task list starts with the syntax `- [ ]` and then the task list item. The formatting is specific! 41 | 42 | 1. Use the **Preview** tab to check your Markdown formatting. 43 | 1. Commit the changes to the file. 44 | 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. 45 | -------------------------------------------------------------------------------- /.github/steps/5-merge-your-pull-request.md: -------------------------------------------------------------------------------- 1 | 6 | 7 | ## Step 5: Merge your pull request 8 | 9 | _Great job adding a task list to the file :heart:_ 10 | 11 | You can now [merge](https://docs.github.com/get-started/quickstart/github-glossary#merge) your pull request! 12 | 13 | ### :keyboard: Activity: Merge your pull request 14 | 15 | 1. Click **Merge pull request**. 16 | 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. 17 | -------------------------------------------------------------------------------- /.github/steps/X-finish.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | ## Finish 7 | 8 | _Congratulations friend, you've completed this course!_ 9 | 10 | celebrate 11 | 12 | Here's a recap of all the tasks you've accomplished in your repository: 13 | 14 | 1. You learned about Markdown, headings, images, code examples, and task lists. 15 | 1. You created and merged a Markdown file. 16 | 1. You learned an essential GitHub skill. 🎉 17 | 18 | ### What's next? 19 | 20 | - You can enable GitHub Pages and see your Markdown file as a website! 21 | 1. Under your repository name at the upper right, click :gear: **Settings**. 22 | 1. Then on the lower left, click **Pages** in the **Code and automation** section. 23 | 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. 24 | 1. Click the **Save** button. 25 | 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. 26 | - Learn more about [Markdown](https://docs.github.com/github/writing-on-github). 27 | - 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) 28 | - [Take another GitHub Skills course](https://github.com/skills). 29 | - [Read the GitHub Getting Started docs](https://docs.github.com/get-started). 30 | - To find projects to contribute to, check out [GitHub Explore](https://github.com/explore). 31 | -------------------------------------------------------------------------------- /.github/workflows/0-welcome.yml: -------------------------------------------------------------------------------- 1 | name: Step 0, Welcome 2 | 3 | # This step triggers after the learner creates a new repository from the template. 4 | # This workflow updates from step 0 to step 1. 5 | 6 | # This will run every time we create push a commit to `main`. 7 | # Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows 8 | on: 9 | workflow_dispatch: 10 | push: 11 | branches: 12 | - main 13 | 14 | # Reference: https://docs.github.com/en/actions/security-guides/automatic-token-authentication 15 | permissions: 16 | # Need `contents: read` to checkout the repository. 17 | # Need `contents: write` to update the step metadata. 18 | # Need `pull-requests: write` to create a pull request. 19 | contents: write 20 | pull-requests: write 21 | 22 | jobs: 23 | # Get the current step to only run the main job when the learner is on the same step. 24 | get_current_step: 25 | name: Check current step number 26 | runs-on: ubuntu-latest 27 | steps: 28 | - name: Checkout 29 | uses: actions/checkout@v4 30 | - id: get_step 31 | run: | 32 | echo "current_step=$(cat ./.github/steps/-step.txt)" >> $GITHUB_OUTPUT 33 | outputs: 34 | current_step: ${{ steps.get_step.outputs.current_step }} 35 | 36 | on_start: 37 | name: On start 38 | needs: get_current_step 39 | 40 | # We will only run this action when: 41 | # 1. This repository isn't the template repository. 42 | # 2. The step is currently 0. 43 | # Reference: https://docs.github.com/en/actions/learn-github-actions/contexts 44 | # Reference: https://docs.github.com/en/actions/learn-github-actions/expressions 45 | if: >- 46 | ${{ !github.event.repository.is_template 47 | && needs.get_current_step.outputs.current_step == 0 }} 48 | 49 | # We'll run Ubuntu for performance instead of Mac or Windows. 50 | runs-on: ubuntu-latest 51 | 52 | steps: 53 | # We'll need to check out the repository so that we can edit the README. 54 | - name: Checkout 55 | uses: actions/checkout@v4 56 | with: 57 | fetch-depth: 0 # Let's get all the branches. 58 | 59 | # Make a branch, file, commit, and pull request for the learner. 60 | - name: Prepare a pull request, branch, and file 61 | run: | 62 | echo "Make sure we are on step 0" 63 | if [ "$(cat .github/steps/-step.txt)" != 0 ] 64 | then 65 | echo "Current step is not 0" 66 | exit 0 67 | fi 68 | 69 | echo "Make a branch" 70 | BRANCH=start-markdown 71 | git checkout -b $BRANCH 72 | 73 | echo "Make a file" 74 | touch index.md 75 | 76 | echo "Make a commit" 77 | git config user.name github-actions 78 | git config user.email github-actions@github.com 79 | git add index.md 80 | git commit --message="Create index.md file" 81 | 82 | echo "Push" 83 | git push --set-upstream origin $BRANCH 84 | 85 | echo "Restore main" 86 | git checkout main 87 | env: 88 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 89 | 90 | # In README.md, switch step 0 for step 1. 91 | - name: Update to step 1 92 | uses: skills/action-update-step@v2 93 | with: 94 | token: ${{ secrets.GITHUB_TOKEN }} 95 | from_step: 0 96 | to_step: 1 97 | branch_name: start-markdown 98 | -------------------------------------------------------------------------------- /.github/workflows/1-add-headers.yml: -------------------------------------------------------------------------------- 1 | name: Step 1, Add headers 2 | 3 | # This step triggers after a commit on the branch `start-markdown`. 4 | # This workflow updates from step 1 to step 2. 5 | 6 | # This will run every time we create push a commit to `start-markdown`. 7 | # Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows 8 | on: 9 | workflow_dispatch: 10 | push: 11 | branches: 12 | - start-markdown 13 | 14 | # Reference: https://docs.github.com/en/actions/security-guides/automatic-token-authentication 15 | permissions: 16 | # Need `contents: read` to checkout the repository. 17 | # Need `contents: write` to update the step metadata. 18 | contents: write 19 | 20 | jobs: 21 | # Get the current step to only run the main job when the learner is on the same step. 22 | get_current_step: 23 | name: Check current step number 24 | runs-on: ubuntu-latest 25 | steps: 26 | - name: Checkout 27 | uses: actions/checkout@v4 28 | - id: get_step 29 | run: | 30 | echo "current_step=$(cat ./.github/steps/-step.txt)" >> $GITHUB_OUTPUT 31 | outputs: 32 | current_step: ${{ steps.get_step.outputs.current_step }} 33 | 34 | on_commit_start_markdown_headers: 35 | name: On commit, start markdown, headers 36 | needs: get_current_step 37 | 38 | # We will only run this action when: 39 | # 1. This repository isn't the template repository. 40 | # 2. The step is currently 1. 41 | # Reference: https://docs.github.com/en/actions/learn-github-actions/contexts 42 | # Reference: https://docs.github.com/en/actions/learn-github-actions/expressions 43 | if: >- 44 | ${{ !github.event.repository.is_template 45 | && needs.get_current_step.outputs.current_step == 1 }} 46 | 47 | # We'll run Ubuntu for performance instead of Mac or Windows. 48 | runs-on: ubuntu-latest 49 | 50 | steps: 51 | # We'll need to check out the repository so that we can edit the README. 52 | - name: Checkout 53 | uses: actions/checkout@v4 54 | with: 55 | fetch-depth: 0 # Let's get all the branches. 56 | 57 | # Check that there is at least one header in the markdown file. 58 | - name: Check markdown syntax, header 59 | uses: skills/action-check-file@v1 60 | with: 61 | file: "index.md" 62 | search: "# [a-zA-Z0-9]" 63 | 64 | # In README.md, switch step 1 for step 2. 65 | - name: Update to step 2 66 | uses: skills/action-update-step@v2 67 | with: 68 | token: ${{ secrets.GITHUB_TOKEN }} 69 | from_step: 1 70 | to_step: 2 71 | branch_name: start-markdown 72 | -------------------------------------------------------------------------------- /.github/workflows/2-add-an-image.yml: -------------------------------------------------------------------------------- 1 | name: Step 2, Add an image 2 | 3 | # This step triggers after a commit on the branch `start-markdown`. 4 | # This workflow updates from step 2 to step 3. 5 | 6 | # This will run every time we create push a commit to `start-markdown`. 7 | # Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows 8 | on: 9 | workflow_dispatch: 10 | push: 11 | branches: 12 | - start-markdown 13 | 14 | # Reference: https://docs.github.com/en/actions/security-guides/automatic-token-authentication 15 | permissions: 16 | # Need `contents: read` to checkout the repository. 17 | # Need `contents: write` to update the step metadata. 18 | contents: write 19 | 20 | jobs: 21 | # Get the current step to only run the main job when the learner is on the same step. 22 | get_current_step: 23 | name: Check current step number 24 | runs-on: ubuntu-latest 25 | steps: 26 | - name: Checkout 27 | uses: actions/checkout@v4 28 | - id: get_step 29 | run: | 30 | echo "current_step=$(cat ./.github/steps/-step.txt)" >> $GITHUB_OUTPUT 31 | outputs: 32 | current_step: ${{ steps.get_step.outputs.current_step }} 33 | 34 | on_commit_start_markdown_image: 35 | name: On commit, start markdown, image 36 | needs: get_current_step 37 | 38 | # We will only run this action when: 39 | # 1. This repository isn't the template repository. 40 | # 2. The step is currently 2. 41 | # Reference: https://docs.github.com/en/actions/learn-github-actions/contexts 42 | # Reference: https://docs.github.com/en/actions/learn-github-actions/expressions 43 | if: >- 44 | ${{ !github.event.repository.is_template 45 | && needs.get_current_step.outputs.current_step == 2 }} 46 | 47 | # We'll run Ubuntu for performance instead of Mac or Windows. 48 | runs-on: ubuntu-latest 49 | 50 | steps: 51 | # We'll need to check out the repository so that we can edit the README. 52 | - name: Checkout 53 | uses: actions/checkout@v4 54 | with: 55 | fetch-depth: 0 # Let's get all the branches. 56 | 57 | # Check that there is at least one image in the markdown file. 58 | - name: Check markdown syntax, image 59 | uses: skills/action-check-file@v1 60 | with: 61 | file: "index.md" 62 | search: "\\!\\[.*](.*)" 63 | 64 | # In README.md, switch step 2 for step 3. 65 | - name: Update to step 3 66 | uses: skills/action-update-step@v2 67 | with: 68 | token: ${{ secrets.GITHUB_TOKEN }} 69 | from_step: 2 70 | to_step: 3 71 | branch_name: start-markdown 72 | -------------------------------------------------------------------------------- /.github/workflows/3-add-a-code-example.yml: -------------------------------------------------------------------------------- 1 | name: Step 3, Add a code example 2 | 3 | # This step triggers after a commit on the branch `start-markdown`. 4 | # This workflow updates from step 3 to step 4. 5 | 6 | # This will run every time we create push a commit to `start-markdown`. 7 | # Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows 8 | on: 9 | workflow_dispatch: 10 | push: 11 | branches: 12 | - start-markdown 13 | 14 | # Reference: https://docs.github.com/en/actions/security-guides/automatic-token-authentication 15 | permissions: 16 | # Need `contents: read` to checkout the repository. 17 | # Need `contents: write` to update the step metadata. 18 | contents: write 19 | 20 | jobs: 21 | # Get the current step to only run the main job when the learner is on the same step. 22 | get_current_step: 23 | name: Check current step number 24 | runs-on: ubuntu-latest 25 | steps: 26 | - name: Checkout 27 | uses: actions/checkout@v4 28 | - id: get_step 29 | run: | 30 | echo "current_step=$(cat ./.github/steps/-step.txt)" >> $GITHUB_OUTPUT 31 | outputs: 32 | current_step: ${{ steps.get_step.outputs.current_step }} 33 | 34 | on_commit_start_markdown_code_example: 35 | name: On commit, start markdown, code example 36 | needs: get_current_step 37 | 38 | # We will only run this action when: 39 | # 1. This repository isn't the template repository. 40 | # 2. The step is currently 3. 41 | # Reference: https://docs.github.com/en/actions/learn-github-actions/contexts 42 | # Reference: https://docs.github.com/en/actions/learn-github-actions/expressions 43 | if: >- 44 | ${{ !github.event.repository.is_template 45 | && needs.get_current_step.outputs.current_step == 3 }} 46 | 47 | # We'll run Ubuntu for performance instead of Mac or Windows. 48 | runs-on: ubuntu-latest 49 | 50 | steps: 51 | # We'll need to check out the repository so that we can edit the README. 52 | - name: Checkout 53 | uses: actions/checkout@v4 54 | with: 55 | fetch-depth: 0 # Let's get all the branches. 56 | 57 | # Check that there is at least one code example in the markdown file. 58 | - name: Check markdown syntax, code example 59 | uses: skills/action-check-file@v1 60 | with: 61 | file: "index.md" 62 | search: "\\`\\`\\`" 63 | 64 | # In README.md, switch step 3 for step 4. 65 | - name: Update to step 4 66 | uses: skills/action-update-step@v2 67 | with: 68 | token: ${{ secrets.GITHUB_TOKEN }} 69 | from_step: 3 70 | to_step: 4 71 | branch_name: start-markdown 72 | -------------------------------------------------------------------------------- /.github/workflows/4-make-a-task-list.yml: -------------------------------------------------------------------------------- 1 | name: Step 4, Make a task list 2 | 3 | # This step triggers after a commit on the branch `start-markdown`. 4 | # This workflow updates from step 4 to step 5. 5 | 6 | # This will run every time we create push a commit to `start-markdown`. 7 | # Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows 8 | on: 9 | workflow_dispatch: 10 | push: 11 | branches: 12 | - start-markdown 13 | 14 | # Reference: https://docs.github.com/en/actions/security-guides/automatic-token-authentication 15 | permissions: 16 | # Need `contents: read` to checkout the repository. 17 | # Need `contents: write` to update the step metadata. 18 | contents: write 19 | 20 | jobs: 21 | # Get the current step to only run the main job when the learner is on the same step. 22 | get_current_step: 23 | name: Check current step number 24 | runs-on: ubuntu-latest 25 | steps: 26 | - name: Checkout 27 | uses: actions/checkout@v4 28 | - id: get_step 29 | run: | 30 | echo "current_step=$(cat ./.github/steps/-step.txt)" >> $GITHUB_OUTPUT 31 | outputs: 32 | current_step: ${{ steps.get_step.outputs.current_step }} 33 | 34 | on_commit_start_markdown_task_list: 35 | name: On commit, start markdown, task list 36 | needs: get_current_step 37 | 38 | # We will only run this action when: 39 | # 1. This repository isn't the template repository. 40 | # 2. The step is currently 4. 41 | # Reference: https://docs.github.com/en/actions/learn-github-actions/contexts 42 | # Reference: https://docs.github.com/en/actions/learn-github-actions/expressions 43 | if: >- 44 | ${{ !github.event.repository.is_template 45 | && needs.get_current_step.outputs.current_step == 4 }} 46 | 47 | # We'll run Ubuntu for performance instead of Mac or Windows. 48 | runs-on: ubuntu-latest 49 | 50 | steps: 51 | # We'll need to check out the repository so that we can edit the README. 52 | - name: Checkout 53 | uses: actions/checkout@v4 54 | with: 55 | fetch-depth: 0 # Let's get all the branches. 56 | 57 | # Make sure there is at least one task list item in the file. 58 | - name: Check markdown syntax, task list 59 | uses: skills/action-check-file@v1 60 | with: 61 | file: "index.md" 62 | search: "\\- \\[ ] " 63 | 64 | # In README.md, switch step 4 for step 5. 65 | - name: Update to step 5 66 | uses: skills/action-update-step@v2 67 | with: 68 | token: ${{ secrets.GITHUB_TOKEN }} 69 | from_step: 4 70 | to_step: 5 71 | branch_name: start-markdown 72 | -------------------------------------------------------------------------------- /.github/workflows/5-merge-your-pull-request.yml: -------------------------------------------------------------------------------- 1 | name: Step 5, Merge your pull request 2 | 3 | # This step triggers after a pull requst is merged to `main`. 4 | # This workflow updates from step 5 to step X. 5 | 6 | # This will run every time we create push a commit to `main`. 7 | # Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows 8 | on: 9 | workflow_dispatch: 10 | push: 11 | branches: 12 | - main 13 | 14 | # Reference: https://docs.github.com/en/actions/security-guides/automatic-token-authentication 15 | permissions: 16 | # Need `contents: read` to checkout the repository. 17 | # Need `contents: write` to update the step metadata. 18 | contents: write 19 | 20 | jobs: 21 | # Get the current step to only run the main job when the learner is on the same step. 22 | get_current_step: 23 | name: Check current step number 24 | runs-on: ubuntu-latest 25 | steps: 26 | - name: Checkout 27 | uses: actions/checkout@v4 28 | - id: get_step 29 | run: | 30 | echo "current_step=$(cat ./.github/steps/-step.txt)" >> $GITHUB_OUTPUT 31 | outputs: 32 | current_step: ${{ steps.get_step.outputs.current_step }} 33 | 34 | on_merge: 35 | name: On merge 36 | needs: get_current_step 37 | 38 | # We will only run this action when: 39 | # 1. This repository isn't the template repository. 40 | # 2. The step is currently 5. 41 | # Reference: https://docs.github.com/en/actions/learn-github-actions/contexts 42 | # Reference: https://docs.github.com/en/actions/learn-github-actions/expressions 43 | if: >- 44 | ${{ !github.event.repository.is_template 45 | && needs.get_current_step.outputs.current_step == 5 }} 46 | 47 | # We'll run Ubuntu for performance instead of Mac or Windows. 48 | runs-on: ubuntu-latest 49 | 50 | steps: 51 | # We'll need to check out the repository so that we can edit the README. 52 | - name: Checkout 53 | uses: actions/checkout@v4 54 | with: 55 | fetch-depth: 0 # Let's get all the branches. 56 | 57 | # In README.md, switch step 5 for step X. 58 | - name: Update to step X 59 | uses: skills/action-update-step@v2 60 | with: 61 | token: ${{ secrets.GITHUB_TOKEN }} 62 | from_step: 5 63 | to_step: X 64 | branch_name: start-markdown 65 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled source # 2 | ################### 3 | *.com 4 | *.class 5 | *.dll 6 | *.exe 7 | *.o 8 | *.so 9 | 10 | # Packages # 11 | ############ 12 | # it's better to unpack these files and commit the raw source 13 | # git has its own built in compression methods 14 | *.7z 15 | *.dmg 16 | *.gz 17 | *.iso 18 | *.jar 19 | *.rar 20 | *.tar 21 | *.zip 22 | 23 | # Logs and databases # 24 | ###################### 25 | *.log 26 | *.sql 27 | *.sqlite 28 | 29 | # OS generated files # 30 | ###################### 31 | .DS_Store 32 | .DS_Store? 33 | ._* 34 | .Spotlight-V100 35 | .Trashes 36 | ehthumbs.db 37 | Thumbs.db 38 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright (c) GitHub, Inc. 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 4 | 5 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 6 | 7 | THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 8 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 | 3 | 9 | 10 | # Communicate using Markdown 11 | 12 | _Organize ideas and collaborate using Markdown, a lightweight language for text formatting._ 13 | 14 |
15 | 16 | 20 | 21 | ## Finish 22 | 23 | _Congratulations friend, you've completed this course!_ 24 | 25 | celebrate 26 | 27 | Here's a recap of all the tasks you've accomplished in your repository: 28 | 29 | 1. You learned about Markdown, headings, images, code examples, and task lists. 30 | 1. You created and merged a Markdown file. 31 | 1. You learned an essential GitHub skill. 🎉 32 | 33 | ### What's next? 34 | 35 | - You can enable GitHub Pages and see your Markdown file as a website! 36 | 1. Under your repository name at the upper right, click :gear: **Settings**. 37 | 1. Then on the lower left, click **Pages** in the **Code and automation** section. 38 | 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. 39 | 1. Click the **Save** button. 40 | 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. 41 | - Learn more about [Markdown](https://docs.github.com/github/writing-on-github). 42 | - 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) 43 | - [Take another GitHub Skills course](https://github.com/skills). 44 | - [Read the GitHub Getting Started docs](https://docs.github.com/get-started). 45 | - To find projects to contribute to, check out [GitHub Explore](https://github.com/explore). 46 | 47 | 61 | -------------------------------------------------------------------------------- /index.md: -------------------------------------------------------------------------------- 1 | # Hello! 2 | 3 | ### It is great to be here! 4 | 5 | image 6 | 7 | ``` javascript 8 | var myVar = "Hello, world!"; 9 | ``` 10 | 11 | - [ ] Wake up 12 | - [ ] Drink coffee 13 | - [ ] Have a great day 14 | --------------------------------------------------------------------------------