Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Specify Markdown note syntax #4352

Merged
merged 9 commits into from
Apr 30, 2021
Merged

Specify Markdown note syntax #4352

merged 9 commits into from
Apr 30, 2021

Conversation

wbamberg
Copy link
Collaborator

@wbamberg wbamberg commented Apr 21, 2021 •
edited
Loading

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).

@wbamberg wbamberg requested a review from a team as a code owner April 21, 2021 17:59
@wbamberg wbamberg requested review from Elchi3 and removed request for a team April 21, 2021 17:59
@wbamberg wbamberg mentioned this pull request Apr 21, 2021
Closed
@github-actions
Copy link
Contributor

github-actions bot commented Apr 21, 2021 •
edited
Loading

Preview URLs

Flaws

URL: /en-US/docs/MDN/Contribute/Markdown_in_MDN
Title: Markdown in MDN
on GitHub

No flaws! 🎉

External URLs

URL: /en-US/docs/MDN/Contribute/Markdown_in_MDN
Title: Markdown in MDN
on GitHub

(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)

ddbeck
ddbeck reviewed Apr 21, 2021
View reviewed changes
Copy link
Contributor

@ddbeck ddbeck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two questions and and a suggestion. Thanks, Will!

files/en-us/mdn/contribute/markdown_in_mdn/index.html Outdated

<h4>Notes</h4>

<p>To write a note, an author creates a GFM blockquote whose first paragraph starts with "**Note:**":</p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this not option 3? I thought option 2 used the h6s?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I lost count.

files/en-us/mdn/contribute/markdown_in_mdn/index.html Show resolved Hide resolved
Ryuno-Ki
Ryuno-Ki reviewed Apr 22, 2021
View reviewed changes
Copy link
Collaborator

@Ryuno-Ki Ryuno-Ki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some typos snucked in.

files/en-us/mdn/contribute/markdown_in_mdn/index.html Outdated Show resolved Hide resolved
files/en-us/mdn/contribute/markdown_in_mdn/index.html Outdated Show resolved Hide resolved
files/en-us/mdn/contribute/markdown_in_mdn/index.html Outdated Show resolved Hide resolved
files/en-us/mdn/contribute/markdown_in_mdn/index.html Show resolved Hide resolved
files/en-us/mdn/contribute/markdown_in_mdn/index.html Outdated Show resolved Hide resolved
files/en-us/mdn/contribute/markdown_in_mdn/index.html Outdated Show resolved Hide resolved
files/en-us/mdn/contribute/markdown_in_mdn/index.html Outdated Show resolved Hide resolved
files/en-us/mdn/contribute/markdown_in_mdn/index.html Outdated Show resolved Hide resolved
wbamberg and others added 6 commits April 22, 2021 16:00
@wbamberg @Ryuno-Ki
Update files/en-us/mdn/contribute/markdown_in_mdn/index.html
576c89a 
Co-authored-by: André Jaenisch <Ryuno-Ki@users.noreply.github.com>
@wbamberg @Ryuno-Ki
Update files/en-us/mdn/contribute/markdown_in_mdn/index.html
0cb1619 
Co-authored-by: André Jaenisch <Ryuno-Ki@users.noreply.github.com>
@wbamberg @Ryuno-Ki
Update files/en-us/mdn/contribute/markdown_in_mdn/index.html
c750790 
Co-authored-by: André Jaenisch <Ryuno-Ki@users.noreply.github.com>
@wbamberg @Ryuno-Ki
Update files/en-us/mdn/contribute/markdown_in_mdn/index.html
b53322e 
Co-authored-by: André Jaenisch <Ryuno-Ki@users.noreply.github.com>
@wbamberg @Ryuno-Ki
Update files/en-us/mdn/contribute/markdown_in_mdn/index.html
63441b3 
Co-authored-by: André Jaenisch <Ryuno-Ki@users.noreply.github.com>
@wbamberg @Ryuno-Ki
Update files/en-us/mdn/contribute/markdown_in_mdn/index.html
e3d8d33 
Co-authored-by: André Jaenisch <Ryuno-Ki@users.noreply.github.com>
@wbamberg wbamberg mentioned this pull request Apr 26, 2021
Merged
Will added 2 commits April 28, 2021 17:07
Update note syntax description
e70a2bb
Merge remote-tracking branch 'origin/specify-note-syntax' into specif…
9667c52 
…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
@wbamberg
Copy link
Collaborator Author

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.

@wbamberg wbamberg merged commit 993c31c into mdn:main Apr 30, 2021
@wbamberg wbamberg mentioned this pull request May 1, 2021
Closed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@hamishwillee hamishwillee hamishwillee left review comments

@Ryuno-Ki Ryuno-Ki Ryuno-Ki left review comments

@ddbeck ddbeck ddbeck approved these changes

@Elchi3 Elchi3 Awaiting requested review from Elchi3

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@wbamberg @ddbeck @Ryuno-Ki @hamishwillee