Skip to content

Add ProseMirror example to documentation site#292

Merged
hackerwins merged 1 commit intomainfrom
prosemirror
Feb 12, 2026
Merged

Add ProseMirror example to documentation site#292
hackerwins merged 1 commit intomainfrom
prosemirror

Conversation

@hackerwins
Copy link
Member

@hackerwins hackerwins commented Feb 12, 2026

What this PR does / why we need it?

Add a new ProseMirror collaborative editing example page following the existing CodeMirror/Quill pattern, using the @yorkie-js/prosemirror binding and the Tree CRDT type.

Any background context you want to provide?

What are the relevant tickets?

Fixes #

Checklist

  • Added relevant tests or not required
  • Didn't break anything

Summary by CodeRabbit

  • New Features
    • Added a new ProseMirror collaborative editor example showcasing real-time collaboration capabilities with Yorkie's Tree CRDT type.
    • The example includes a live preview, code viewer, and comprehensive guide documentation.

Add a new ProseMirror collaborative editing example page following the
existing CodeMirror/Quill pattern, using the @yorkie-js/prosemirror
binding and the Tree CRDT type.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link

coderabbitai bot commented Feb 12, 2026

📝 Walkthrough

Walkthrough

This PR adds a new vanilla ProseMirror collaborative editor example to the codebase. It includes the example file descriptor, a new Next.js page component for displaying the example, updates to the example registry, and modifications to build and fetch scripts to incorporate the new example.

Changes

Cohort / File(s) Summary
Example File Structure
examples/vanilla-prosemirror/fileInfo.ts
New file exporting FILE_INFO constant describing the directory structure and content of the vanilla-prosemirror example for programmatic access.
Example Pages
pages/examples/index.tsx, pages/examples/prosemirror.tsx
Added new ProseMirror example entry to the EXAMPLES registry and created a new Next.js page component that renders the example with sidebar, code viewer, and live preview iframe using ExampleLayout utilities.
Build and Fetch Scripts
scripts/build-js-examples.mts, scripts/fetch-js-examples.mts
Updated build script to include 'vanilla-prosemirror' in STATIC_EXAMPLES list and extended package.json regex to handle prosemirror package versioning alongside existing sdk and react packages.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 A new example hops into the pen,
With ProseMirror dancing once again,
File info mapped, registry fed,
Scripts updated with prosemirror thread,
Collaboration blooms in every spread! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main objective of the pull request: adding a ProseMirror example to the documentation site.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch prosemirror

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@hackerwins hackerwins merged commit 90a892a into main Feb 12, 2026
2 checks passed
@hackerwins hackerwins deleted the prosemirror branch February 12, 2026 01:24
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