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