Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Proposal: Standardize listing of Markdown Flavors used in the MD document: GLFM, GFM, QMD, etc

Đang mở
  • Có gì không ổn?
#830 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Ít trao đổi
Công nghệ
markdown
Lĩnh vực
documentation

Hướng nghiên cứu

Start by reviewing the proposal in issue #830 and the flavor vocabulary and references in RFC 7764 section 3. The issue names no repository files, tests, or implementation entry point. Done would require agreement on a standardized front matter key, naming vocabulary, and priority semantics before implementation work can be defined.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Standardizing a single common Markdown syntax seems like an impossible challenge!

So, now we already have a lot of different popular “flavors” for Markdown syntax: CommonMark, GitLab Flavored Markdown (GLFM), GitHub Flavored Markdown (GFM), Quarto (QMD), Markdown Extra, MultiMarkdown, R Markdown, etc.

And have a lot of .md files that can use different flavors, even more than one in a single document…

But we have no standardized approach to describe which flavors should be used to render this specific .md file!

As a result, file viewers can only guess which flavor to try to apply to render the document correctly!

Let’s fix this by proposing a standard to list the flavors, used in the current document, to give the viewers and renderers a clue how to render this Markdown file correctly.

My proposal is to recommend using the Front Matter block with the flavors key like this:

---
title: Foo
flavors:
  - GFM
  - R-Markdown
---
The markdown body.

The list of flavor names is already tracked in the RFC 7764 , as I understand, so we can use the naming vocabulary from there, and the RFC contains links to the references.

Also, we can name this key not as flavors but as extensions or plugins to be clearer.

The list of flavors is an array, to make it possible to set the priorities (first is the winner) of how to render specific blocks, if they are covered by more than one flavor.

Alternatively, we can put a link to the specifications in addition to the flavor name (unique ID) in this list, but in such a case, we should standardise the format of the specification, which is a hard challenge too.

What do you think about this idea?

Ngôn ngữ chính
Python
Star
5.1k
Fork
359
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của commonmark/commonmark-spec

Tất cả issue của commonmark/commonmark-spec

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.