Format admonitions

[ErikSchierboom]

• Add script to format admonitions
• Format admonitions in format-md NPM script
• Update admonitions

[ErikSchierboom]

CC @exercism/reviewers

[ee7]

So, should tracks that format files with prettier also do this?

I checked that, with this PR, there's no more backtick-using admonition in this repo:

$ git rev-parse --short HEAD
909c8864
$ git grep --break --heading '`exercism/' -- '*.md'
$ git grep --break --heading '~exercism/' -- '*.md'
exercises/binary:search/instructions.md
8:~~~~exercism/caution

exercises/etl/instructions.md
25:~~~~exercism/note

exercises/gigasecond/introduction.md
16:~~~~exercism/note

exercises/linked:list/instructions.md
16:~~~~exercism/note

exercises/pangram/introduction.md
10:~~~~exercism/note

exercises/rational:numbers/description.md
5:~~~~exercism/note

exercises/rna:transcription/instructions.md
18:~~~~exercism/note

exercises/rna:transcription/introduction.md
7:~~~~exercism/note

exercises/secret:handshake/instructions.md
44:~~~~exercism/note

exercises/sieve/instructions.md
21:~~~~exercism/note

exercises/simple:linked-list/instructions.md
10:~~~~exercism/note

[iHiD]

So, should tracks that format files with prettier also do this?

Yes. And Erik's going to do a big PR for it I believe.

[ErikSchierboom]

So, should tracks that format files with prettier also do this?

Ideally, yes I think. We could also bake this check into configlet maybe?

[ee7]

We could also bake this check into configlet maybe?

That's possible. But I think it'd be better to have an org-wide workflow that runs markdownlint, checks admonitions, and performs any other Exercism-specific markdown linting. One reason: configlet lint only runs in track repos, and not every repo that may contain an admonition is a track repo.

Thoughts?

Related: exercism/configlet#562
Related: exercism/configlet#741

[ErikSchierboom]

That's possible. But I think it'd be better to have an org-wide workflow that runs markdownlint, checks admonitions, and performs any other Exercism-specific markdown linting. Thoughts?

That's a nice idea

[ee7]

I previously created a tracking issue for it: exercism/org-wide-files#214

[ErikSchierboom]

CC @exercism/reviewers Once this PR is merged, I can do the cross-repo PR.