Skip to content

Commit f7028cf

Browse files
Update curriculum_spec.md
1 parent a88ea19 commit f7028cf

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

curriculum_spec.md

+55
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,61 @@ When you take a look at it on GitHub, it may look a bit like this
2020

2121
Note that the various stages of the project are represented by [Git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules). Each module links to a particular branch in the project repository, corresponding to that stage. Note that
2222
the actual [project repository](https://github.com/codingandcommunity/sample-app/) that the curriculum is based off of is external to the curriculum repository.
23+
24+
### Copilot Markdown
25+
26+
The content shown to the user in the sidebar (instructions, descriptions, etc.) will be loaded from Markdown files with a few special additions.
27+
28+
#### Example:
29+
30+
Code:
31+
```
32+
#include <stdio.h>
33+
#include <stdlib.h>
34+
35+
int main() {
36+
int x, y, sum;
37+
38+
/// @ref:step1.1
39+
/// Use scanf here to read in two numbers to x and y!
40+
41+
sum = x + y
42+
printf( "%d", sum );
43+
return 0;
44+
}
45+
46+
```
47+
Markdown:
48+
```
49+
---
50+
title: Step 1
51+
next: step_2.md
52+
prev: introduction.md
53+
jumpto: @ref:step1.1
54+
---
55+
Given a variable declaration `int x` we can use `scanf("%d", x)` can be used to a read an integer from the console and assign it to x. Use that [here](@ref:step1.1) to read in two integers, compute the sum, and assign it to `sum`!
56+
```
57+
58+
#### Header Tags
59+
* ```title```: Title to display in sidebar
60+
* ```next```: A next button will be shown in the sidebar and will load the specified file when clicked.
61+
* ```prev```: ''
62+
* ```jumpto```: Line or reference to jump to when the markdown is loaded
63+
64+
#### Special Comments and Tags
65+
66+
* Code reference: Can be used to reference a specific line of code.
67+
* Code:
68+
```
69+
### @ref:label or /// @ref:label
70+
```
71+
72+
* Code anchor links: Links to code anchor with corresponding label.
73+
* Markdown:
74+
```
75+
[link text](@ref:label)
76+
```
77+
2378
### Project Task Specifications
2479

2580
### Concept Specifications

0 commit comments

Comments
 (0)