Skip to content

Instantly share code, notes, and snippets.

@kaitvan
Last active February 21, 2023 23:31
Show Gist options
  • Save kaitvan/9cfb8d419dd3ca6a3651b201864c194f to your computer and use it in GitHub Desktop.
Save kaitvan/9cfb8d419dd3ca6a3651b201864c194f to your computer and use it in GitHub Desktop.

Markdown Assignment Feedback

Don't bother making a header bold. If you bold a header, it won't make a difference, because headers automatically have bold formatting. The following two headers are both level 2 headers with double # in front, but the first is also bolded (**). You can't see the difference!

3 Tips to Improve Your Work

  1. In numbered lists, you don't have to number them. Start everything with a 1. and it will automatically number them for you! 🤯 Click the raw version of this markdown file to see an example!
  2. For fenced code blocks, you do need the three backtics to close the block. If you don't, anything you write after that will be included in the fenced code block.
  3. Only use a single backtic on either side of the word or phrase to create an inline code block. A few people had two backtics on either side. GitHub seems to adjust it for you and render it the same, but not every space would recognize that as valid Markdown. Like Slack, for example!
var sentence = "Here's a string stored in a variable.";
console.log(sentence);

If you don't include the last three backtics, your code block will never end. So it's not really that removing them altogether or putting them on their own line works. Putting them on their own line is the correct syntax, so that you can end your code block!

var name = "Kaitlyn"; var location = "Austin"; console.log(Hi, ${name} from ${location}. It's so nice to meet you!


Basically, all of your formatting is off if you don't specifically tell it when to open and end a code block with those three backtics.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment