Skip to content

Commit d3a8dda

Browse files
authored
emoji test
1 parent 4f8052c commit d3a8dda

File tree

1 file changed

+65
-11
lines changed

1 file changed

+65
-11
lines changed

docs/index.md

Lines changed: 65 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ Ines Montani has created this framework using Gatsby and Reveal.js in the front-
1010
This project is under active development and there are possibilities of changes. If you would like to contribute or point out corrections, please create a new issue addressing your concern, suggestions or contribution.
1111
[![](https://user-images.githubusercontent.com/13643239/56341448-68fe9380-61b5-11e9-816f-5c71ae71b94f.png)](https://course-starter-python.netlify.com)
1212

13+
🔆This symbol will be used in this guide for helpful tips/recomendations and suggestions when building your course.
14+
🛑
15+
⚠️ Testing emoji
16+
🚨
1317

1418
## What To Expect
1519

@@ -410,7 +414,7 @@ These are the files that make up the topics of your course and will be displayed
410414

411415
<br>
412416

413-
each md file in here will need the specified yaml that Ines explains:
417+
each `chapter.md` file will need this yaml specification that Ines explains:
414418

415419
```
416420
---
@@ -424,11 +428,11 @@ type: chapter # important: this creates a standalone page from the chapter
424428
```
425429
Here are some additional comments:
426430

427-
1. Make sure each id is unique or you may have some issues with some modules not showing up
428-
2. Make sure that you take care specifying the correct `prev` and `next` otherwise it could damage the flow of your material.
429-
3. you don't need to have your extension of your course labeled as "chapters" if you wish to call each topic here something other than chapter in the url then simply change the file names to `module`, `topic`, `lecture` followed by the number instead. Do not change the folder name and do not change the `type` in the yaml.
431+
1. Make sure each `id` is unique or you may have some issues with some modules not showing up.
432+
2. Take care specifying the correct `prev` and `next` otherwise it could damage the flow of your material.
433+
3. You don't need to have your website extension of your course labeled as "chapters" if you wish to have your link extensions named something other than chapter in the url, you can change the file names to `module`, `topic`, `lecture` or anything else followed by the number. Do not change the folder name and do not change the `type` in the yaml.
430434

431-
Each chapter file with contain the code of what that chapter will look like. Specifically:
435+
Each `chapter.md` file will contain the code of what that chapter will look like. Specifically:
432436

433437
![](img/chapter_layout.png)
434438
<font size="1" color="grey">Source: Ines Montani from https://course.spacy.io/chapter1</font>
@@ -437,7 +441,7 @@ Each chapter file with contain the code of what that chapter will look like. Spe
437441

438442
Now that we have a chapter.md file with a completed yaml, lets add the course content.
439443

440-
Each numbered container dispayed in the chapter image corresponds to an `exercise`. Each exercise needs a unique id and specified with a title.
444+
Each numbered container dispayed in the image above corresponds to an `exercise`. Each exercise needs a unique id and specified with a title.
441445

442446
```
443447
<exercise id="1" title="Title of the exercise">
@@ -448,10 +452,9 @@ something here
448452
```
449453

450454
These exercises can in the form of different activities as well:
451-
]
452455
1. Slides: Lecture material and content
453-
2. Codeblock exercises: An opportunity for students to test their coding skills
454-
3. Multiple choice questions: : An opportunity for students to test themselves on the material they just learned.
456+
2. Multiple choice questions: : An opportunity for students to test themselves on the material they just learned.
457+
3. Codeblock exercises: An opportunity for students to test their coding skills
455458

456459

457460
### Slides
@@ -472,7 +475,7 @@ You'll also notice we are calling a source file to display our slides. These sli
472475

473476
[Ines explaines](https://github.com/ines/course-starter-python#slides) how your slide mardown document should be structured.
474477

475-
***WARNING: Be wary of trailing spaces 😵😱!! Although `---` may appear to be the same as `--- ` they are not and any information placed after the latter will break your slides.***
478+
***WARNING: Be wary of trailing spaces 😵😱!! Although ```---``` may appear to be the same as ```--- ``` they are not and any information placed after the latter will break your slides.***
476479

477480
#### Enbedding Video and Audio
478481

@@ -499,13 +502,64 @@ _The video size should now respond to the browser size adjustment. `video-file-n
499502
```
500503
_`audio-file-name.mp3` should be living in the `static` folder._
501504

505+
### Multiple choice questions:
506+
507+
In a similar style to slide you will have code that looks like the following
508+
509+
```
510+
<exercise id="10" title="Fit or Predict">
511+
512+
Insert questions here.
513+
514+
<choice>
515+
<opt text="Solution 1" correct="true">
516+
517+
Great job! Training on training data must be done before predicting on new data.
518+
519+
</opt>
520+
521+
<opt text="Solution 2" >
522+
523+
How can the model predict without education first?
524+
525+
</opt>
526+
</choice>
527+
</exercise>
528+
```
529+
- Your question text will live in the `<exercise>`.
530+
- You can then specify the solution options that correspond to this question using `<choice>`.
531+
- Each option will live in `<opt>`. If you want to specify a solution option as correct you can give it an argument `correct="true"` otherwise if it's wrong, no argument is needed. 🔆***You may have multiple right answers in a question***
532+
533+
534+
_Note: You must have padding (empty lines) above and below your question text as well as your answer feedback text as shown above._
535+
536+
If you wish to specify the correct answers
537+
502538
### Codeblock Exercises:
503539

540+
In a fashion similar to slides we are going to reference a source file that corresponds to the coding activity.
541+
your code in `chapter.md` will look like this:
542+
543+
```
544+
<exercise id="13" title="Calculating Gini Impurity">
545+
546+
547+
You can type your question instructions here
548+
549+
550+
<codeblock id="exercise-file-name">
551+
552+
In this space is where you will write any coding or question hints
553+
554+
555+
</codeblock>
556+
</exercise>
557+
```
504558

505559

506560
#### `binder/requirements.txt`
507561

508-
### Multiple choice questions:
562+
509563

510564

511565
### `static` folder

0 commit comments

Comments
 (0)