Specify Markdown note syntax #4352
Conversation
Preview URLsFlawsURL: No flaws! 🎉 External URLsURL:
(this comment was updated 2021-04-22 23:03:19.327454) (this comment was updated 2021-04-22 23:18:37.278752) (this comment was updated 2021-04-22 23:18:52.536183) (this comment was updated 2021-04-22 23:19:05.300486) (this comment was updated 2021-04-22 23:19:06.608356) (this comment was updated 2021-04-22 23:19:08.548886) (this comment was updated 2021-04-22 23:19:10.965225) (this comment was updated 2021-04-22 23:19:12.170167) (this comment was updated 2021-04-29 00:11:34.907483) |
|
|
||
| <h4>Notes</h4> | ||
|
|
||
| <p>To write a note, an author creates a GFM blockquote whose first paragraph starts with "**Note:**":</p> |
There was a problem hiding this comment.
Is this not option 3? I thought option 2 used the h6s?
There was a problem hiding this comment.
Yeah, I lost count.
Co-authored-by: André Jaenisch <Ryuno-Ki@users.noreply.github.com>
Co-authored-by: André Jaenisch <Ryuno-Ki@users.noreply.github.com>
Co-authored-by: André Jaenisch <Ryuno-Ki@users.noreply.github.com>
Co-authored-by: André Jaenisch <Ryuno-Ki@users.noreply.github.com>
Co-authored-by: André Jaenisch <Ryuno-Ki@users.noreply.github.com>
Co-authored-by: André Jaenisch <Ryuno-Ki@users.noreply.github.com>
…y-note-syntax * origin/specify-note-syntax: Update files/en-us/mdn/contribute/markdown_in_mdn/index.html Update files/en-us/mdn/contribute/markdown_in_mdn/index.html Update files/en-us/mdn/contribute/markdown_in_mdn/index.html Update files/en-us/mdn/contribute/markdown_in_mdn/index.html
|
OK, I think I have addressed Daniel's #4352 (comment) and Hamish's #4352 (comment). In the end it seemed like things would go better if I separated stuff about the syntax from the examples, so that's what I've done now. |
This PR updates the "MDN Markdown" spec to talk about representing notes, warnings, and what I'm awkwardly calling "callouts", based on conversations in #3483 and #3927.
I'm choosing option 2 from #3483 as the authoring format, where you use a blockquote and a magic word at the start of the content, and asking this to be converted to the
<div class="thing">syntax in the output (and I think in the internal representation, although I haven't specified that here, and perhaps I should).