bats-core / bats-assert

Common assertions for Bats
Creative Commons Zero v1.0 Universal
94 stars 39 forks source link

readme tweaks #57

Closed jasonkarns closed 1 year ago

jasonkarns commented 1 year ago

Leverage github's new rendering for blockquoted notes and warnings.

blockquoted notes render as:

image

and warnings:

image

AFAICT, for the nice rendering to work, it must be:

  1. blockquoted (prefixed with >)
  2. Note/Warning must be precisely titlecased, bold and without punctuation (colon may follow but may not be within the bold markers)

I'm ambivalent about whether the notes and warnings read better as italics or not. They were italicized before, so I left them. Though they weren't "blockquoted" before, which has its own styling that probably makes the italics unnecessary? 🤷

Also fixed up a couple broken reference links