Skip to content

Commit 2b20d4d

Browse files
docs: update README with table of contents and notable resources section (#36)
1 parent a2f9b10 commit 2b20d4d

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@
44
<img src="https://octodex.github.com/images/manufacturetocat.png" alt="Manufacturetocat" width="300" />
55
</p>
66

7+
- [Skills Exercises Toolkit :hammer\_and\_wrench:](#skills-exercises-toolkit-hammer_and_wrench)
8+
- [Purpose](#purpose)
9+
- [Contents](#contents)
10+
- [Examples](#examples)
11+
- [⚙️ Reusable Workflows](#️-reusable-workflows)
12+
- [Starting an exercise](#starting-an-exercise)
13+
- [Finding an exercise](#finding-an-exercise)
14+
- [📋 Markdown Templates](#-markdown-templates)
15+
- [Notable Resources](#notable-resources)
16+
717
## Purpose
818

919
This repository serves as a comprehensive toolkit for creating and managing GitHub Skills exercises. It provides a collection of tools, templates, and utilities designed to streamline the process of developing educational content for GitHub Skills.
@@ -29,21 +39,17 @@ jobs:
2939
with:
3040
exercise-title: "Introduction to GitHub Copilot"
3141
intro-message: "Let's get you started with GitHub Copilot :robot: ! We will learn ..."
32-
3342
```
3443
3544
#### Finding an exercise
3645
3746
```yaml
38-
3947
jobs:
4048
find_exercise:
4149
name: Find Exercise Issue
4250
uses: skills/exercise-toolkit/.github/workflows/find-exercise-issue.yml@<git-tag>
43-
4451
```
4552
46-
4753
### 📋 Markdown Templates
4854
4955
For a full list of markdown templates go to the **[markdown-templates](/markdown-templates)** directory.
@@ -60,7 +66,6 @@ steps:
6066
- name: Use the template
6167
run: |
6268
cat exercise-toolkit/markdown-templates/step-feedback/checking-work.md
63-
6469
```
6570
6671
Markdown templates are often used together with [skills/action-text-variables](https://github.com/skills/action-text-variables) GitHub Action
@@ -86,5 +91,12 @@ steps:
8691
run: echo "$UPDATED_TEXT"
8792
env:
8893
UPDATED_TEXT: ${{ steps.build-message-congratulations.outputs.updated-text }}
89-
9094
```
95+
96+
## Notable Resources
97+
98+
These GitHub Actions are particularly useful when creating GitHub Skills Exercises:
99+
100+
- **[skills/action-text-variables](https://github.com/skills/action-text-variables)**: Replace variables in template files with dynamic content
101+
- **[skills/action-keyphrase-checker](https://github.com/skills/action-keyphrase-checker)**: Verify if specific keyphrases exist in files or content
102+

0 commit comments

Comments
 (0)