Heads up! To view this whole video, sign in with your Courses account or enroll in your free 7-day trial. Sign In Enroll
Preview
Start a free Courses trial
to watch this video
Markdown is text to HTML conversion system that allows you to write in plain-text and then easily convert to HTML.
We've got our issue,
Python track courses to be completed and
0:00
now let's add a description and
make use of the markdown formatting.
0:04
Documentation for markdown is linked here,
so let's take a look at it.
0:08
This link is also in the teacher's notes.
0:11
So it looks like there's an intro and
some examples.
0:14
Let's see the examples.
0:20
We can see that using the double
asterisk makes a word bold and
0:22
using one asterisk makes the word italic.
0:25
To create a link, you use brackets and
the URL in parentheses.
0:28
There are additional
examples of how to create
0:32
a numbered list and a bulleted list.
0:36
How to embed an image.
0:40
Use Headers and Quotes.
0:45
Style Code.
0:49
And also, how to create task lists and
use emoji.
0:54
We'll use most of these in our issue.
0:57
Back in our issue body,
1:00
I'll add the equivalent of an h2
tag with two hashes and type TODO.
1:01
I can preview it to make sure
it looks like I want it to.
1:07
Looks good.
1:12
Next, I'll add some italics.
1:13
I'll use a task list to check
the remaining courses to be completed.
1:28
And I'll add some emoji
to show my excitement.
1:58
There's also a link to the emoji cheat
sheet in the teachers notes with a list of
2:09
all the emojis supported on GitHub.
2:12
Last by typing an at symbol
followed a username,
2:15
you can notify a person to come and view
the comment, also called an at mention.
2:18
I'll CC my friend Kyle since he said,
2:23
he was interested to know
what courses I'm taking.
2:25
We'll Preview.
2:33
Awesome, it looks great and
click Submit new Issue.
2:36
When I finish my courses,
I'll check them off.
2:41
And eventually, close the issue
when the tasks are all completed.
2:42
Also, cool is every issue has a unique URL
that I can send to someone and go back and
2:47
reference even after the issue is closed.
2:51
Back in the Issues view, we can see
that we've got our two open issues.
2:54
To review,
2:58
you can open an issue to create a note of
something related to your repository and
2:59
we learned how to effectively
use Markdown to style our text.
3:03
In the next video,
3:07
we'll talk about a best practice as
a work flow to make changes to a project.
3:08
You need to sign up for Treehouse in order to download course files.
Sign up