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.

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

Allow text/markdown in 7.1 #607

Open
wants to merge 2 commits into
base: v7.1
Choose a base branch
from
Open

Conversation

dthaler
Copy link
Collaborator

@dthaler dthaler commented Mar 11, 2025

Fixes #222

Fixes FamilySearch#222

Signed-off-by: Dave Thaler <[email protected]>
@dthaler dthaler changed the title Allow text/markdown Allow text/markdown in 7.1 Mar 11, 2025

If needed, `text/html` can be converted to `text/plain` using the following steps:
- `**`, `*`, `__`, and `~~` for bold, italic, underlined, and strike-through text.
Copy link
Collaborator

@tychonievich tychonievich Mar 18, 2025

Choose a reason for hiding this comment

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

~~ is not part of the original Markdown definition nor of commonmark; while useful, it is an extension and perhaps does not belong in this spec

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Updated


</div>

Supporting more of [Markdown](https://commonmark.org) is encouraged.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Discussed in steering committee 18 MAR 2025

The listed subset of commonmark is small, relative to the spec as a whole (omitting at least block quotes, inline code, code blocks, hard breaks, H3 through H6, underlined header syntax, inline HTML, horizontal rules, images, links, escaping characters), and lacks the clarifications about syntactic ambiguities that commonmark has (though some of those are introduced by things we omit).

  • Should we encourage supporting all of CommonMark or just the provided subset?
  • Should we keep the subset but reference CommonMark for syntactic ambiguity?
  • Should we remove the subset and simply reference CommonMark?
  • Should we say anything about supporting CommonMark extensions (like strike-through or definition lists)?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Updated

@Norwegian-Sardines
Copy link

Norwegian-Sardines commented Mar 18, 2025

Part of the reason I included "strike out" in the list of supported (potential) markdown was to emulate what was specified in the HTML text. I was hoping to match the HTML spec but that got side tracked when I also need to include the other codes used by the software I use that include headings.

I'm okay with indicating the the base support starts with CommonMark (probably should be spelled out), but it can be extended to support other markdown. The spec has already indicated that HTML can use other MarkupLanguage as needed so the Markdown needs similar wording!

Should we encourage supporting all of CommonMark?

Yes

Should we say anything about supporting CommonMark extensions (like strike-through or definition lists)?

Yes, the spec indicates the "encouragement" for other tags for HTML

Signed-off-by: Dave Thaler <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants