Skip to content

docs: update Markdown feature support list with GFM comparison - #24

Merged
geopanther merged 1 commit into
mainfrom
docs/update-makrdown-feature-support-list
May 8, 2026
Merged

docs: update Markdown feature support list with GFM comparison#24
geopanther merged 1 commit into
mainfrom
docs/update-makrdown-feature-support-list

Conversation

@geopanther

Copy link
Copy Markdown
Owner

Summary

Reorganizes and enhances the Markdown plugin documentation in the README:

  • Moved the supported plugins table from the top of the README to a dedicated section at the bottom for better readability
  • Added a GitHub (GFM) column to the plugin table showing feature parity with GitHub Flavored Markdown
  • Added a new "GitHub-only features not supported by Mistune" table covering Alerts, Mermaid, Emoji shortcodes, GeoJSON, etc.
  • Replaced the top-level section with a brief summary and anchor link to the full table

Motivation

Users coming from GitHub often want to know which Markdown features will render correctly in Confluence. The GFM comparison column and the unsupported-features table make this immediately clear.

Changes

  • README.md — restructured Markdown plugin docs, added GFM comparison column, added unsupported GFM features table

Moved markdown feature support list to the end of the document

Added reference to feature support list in ## Features section.

Added compatibility overview between github flavoured markdown and mdfluence.
@geopanther
geopanther merged commit 55fbdab into main May 8, 2026
5 checks passed
@geopanther
geopanther deleted the docs/update-makrdown-feature-support-list branch May 13, 2026 09:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant