Bitzu

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 code and 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.

Source: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax

Practice questions

Single choice

Which characters format a short piece of text as inline code in Markdown?

  1. Single backticks around the text
  2. Double quotes around the text
  3. A leading > character
  4. 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.

Select all that apply

Which lines create task list items?

  1. - [ ] Write tests
  2. - [x] Write tests
  3. # [ ] Write tests
  4. > [x] Write tests
  5. [ ] 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

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.

Download on the App StoreGet it on Google Play

More GH-900 topics in this module