GH-900 ยท Working with GitHub
Markdown in issues and pull requests
Markdown syntax for headings, lists, code blocks, links, task lists, mentions and issue references, and why it is used on GitHub.
Key points
- Markdown is a light plain-text syntax that GitHub renders as formatted text: # headings, bold, - lists, - [ ] task lists,
inline codeand fenced code blocks, [text](url) links, @username mentions and #123 references to issues or pull requests. - It keeps descriptions readable and structured without a rich-text editor.
Practice questions
Which characters format a short piece of text as inline code in Markdown?
- Single backticks around the text
- Double quotes around the text
- A leading > character
- Two asterisks around the text
Show answer
Answer: A. Single backticks around the text
Single backticks mark inline code; triple backticks fence a code block. Quotes and asterisks do other things.
Which lines create task list items?
- - [ ] Write tests
- - [x] Write tests
- # [ ] Write tests
- > [x] Write tests
- [ ] Write tests
Show answer
Answer: A. - [ ] Write tests, B. - [x] Write tests
A task list item starts with a dash, a space and brackets, either empty or with an x. A heading or a quote with brackets is not a checkbox.
True or false: starting a line with three # characters creates a level 1 heading.
Show answer
Answer: False
False. The number of # characters sets the level, so three give a level 3 heading; a single # gives level 1.
Practice 8 questions on this topic in Bitzu
Short lessons, instant explanations and spaced review of what you get wrong. Free on iOS and Android.
