-
-
Notifications
You must be signed in to change notification settings - Fork 188
Open
Description
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
- https://sonicjs.com/plugins#editor-plugins
States EasyMDE field type iseasymdeormarkdown. - https://sonicjs.com/field-types#rich-text-fields
Labels asmdxeditor/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'andtype: '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:
- Docs correction (fast): canonicalize on
mdxeditorfor EasyMDE plugin usage. - Runtime aliases (full): support
easymdeandmarkdownas aliases to the samemdxeditorpath, and document all accepted
aliases clearly.
Also clarify plugin status:
- whether
easymde-editoris legacy/deprecated - whether
easy-mdxis the canonical plugin going forward.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels