Skip to content

Bug: Docs conflict on EasyMDE/MDX field types and plugin naming (easy-mdx vs easymde-editor) #674

@bobbwal

Description

@bobbwal

Summary

Public docs currently provide conflicting guidance for markdown editor field types and plugin naming. This leads users to configure unsupported field types.

Conflicting docs

  1. https://sonicjs.com/plugins#editor-plugins
    States EasyMDE field type is easymde or markdown.
  2. https://sonicjs.com/field-types#rich-text-fields
    Labels as mdxeditor / markdown, but example uses:
{ 
  type: 'mdxeditor', 
  title: 'Documentation', 
  height: 400 
}

Plugin naming confusion

Two plugin entries are visible in ecosystem/history:

  • EasyMDE Markdown Editor (easy-mdx)
  • EasyMDE Editor (easymde-editor)

Current runtime/editor wiring appears to use easy-mdx + mdxeditor field path, while docs still reference easymde/markdown in
places.

Actual runtime behavior (current code)

  • type: 'mdxeditor' is the working markdown editor path.
  • type: 'easymde' and type: 'markdown' are not consistently wired end-to-end and can fall back to plain text rendering.

Impact

Users following docs may choose easymde or markdown and get unexpected non-editor behaviour, with confusion amplified by two
similarly named EasyMDE plugins.

Expected

Docs and runtime should agree on one canonical field type contract for EasyMDE markdown editing.

Proposed resolution

Choose one direction and align all docs/pages:

  1. Docs correction (fast): canonicalize on mdxeditor for EasyMDE plugin usage.
  2. Runtime aliases (full): support easymde and markdown as aliases to the same mdxeditor path, and document all accepted
    aliases clearly.

Also clarify plugin status:

  • whether easymde-editor is legacy/deprecated
  • whether easy-mdx is the canonical plugin going forward.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions