Changelog #

All notable changes to Marzipan are documented here. This project follows Semantic Versioning.

[Unreleased] #

✨ Added #

• Zero-Dependency Actions Suite - Bundled the full markdown action suite under src/actions and exported it from the core package. Projects no longer need the external markdown-actions dependency!

  ts

  import { actions } from '@pinkpixel/marzipan';
  actions.toggleBold(textarea);
  

• Plugin Collection - Comprehensive plugin ecosystem now published from src/plugins:

  • Table plugins (basic, grid picker, generator)
  • Mermaid diagram rendering
  • Syntax highlighting
  • Image management
  • Accent color swatches

• Enhanced Documentation - Complete documentation refresh covering:

  • New action utilities and APIs
  • Plugin development guides
  • Framework integration examples
  • Interactive demos and examples

🔄 Changed #

• Contribution Guidelines - Updated to reflect streamlined package layout and Node.js 20+ requirement
• Documentation Structure - Reorganized docs for better navigation and clarity
• Quick Start - Simplified onboarding with clearer examples and framework-specific guides

🐛 Fixed #

• Various TypeScript type improvements
• Plugin initialization edge cases

[1.0.7] - 2025-09-26 #

🎉 Initial Public Release #

The first public release of Marzipan! A pure TypeScript markdown editor with innovative overlay preview.

✨ Core Features #

• Overlay Preview System - Revolutionary approach to markdown rendering

  • Perfect pixel alignment between source and rendered output
  • No split panes or synchronization issues
  • Seamless editing experience

• Zero Dependencies - All markdown formatting built-in

  • No external formatting libraries needed
  • Reduced bundle size
  • Better tree-shaking

• Theming System - Beautiful built-in themes

  • Solar (light theme)
  • Cave (dark theme)
  • Custom theme support

• Editor Features

  • Customizable toolbar with formatting buttons
  • Smart list continuation
  • Keyboard shortcuts
  • Statistics panel (words, chars, lines)
  • Auto-resize option
  • Mobile-optimized

🧩 Plugin Foundation #

• Extensible plugin architecture
• Tree-shakeable design
• First-party plugins included

📚 Documentation #

• Complete TypeScript declarations
• API reference documentation
• Usage guides and examples
• Contribution guidelines

🎮 Bakeshop Demo #

• Full-featured React playground
• Live examples of all features
• Plugin showcase
• Theme customization demo

Migration Guides #

Upgrading to 1.0.7+ #

If you're upgrading from a pre-release version:

1. Update Package

   bash

   npm update @pinkpixel/marzipan
   

2. Remove Old Dependencies

   bash

   npm uninstall markdown-actions  # No longer needed!
   

3. Update Imports

   ts

   // Old (external dependency)
   import { toggleBold } from 'markdown-actions';
   
   // New (bundled with Marzipan)
   import { actions } from '@pinkpixel/marzipan';
   actions.toggleBold(textarea);
   

4. Update Plugin Imports

   ts

   // Import plugins from the new paths
   import { tablePlugin } from '@pinkpixel/marzipan/plugins/tablePlugin';
   import { mermaidPlugin } from '@pinkpixel/marzipan/plugins/mermaidPlugin';
   

Version History #

Release Schedule #

Marzipan follows semantic versioning:

• Major (x.0.0) - Breaking changes
• Minor (1.x.0) - New features, backwards compatible
• Patch (1.0.x) - Bug fixes, backwards compatible

Deprecation Policy #

When features are deprecated:

1. Announced in release notes
2. Warnings logged in development mode
3. Removed in next major version

Contributing #

Found a bug or have a feature request?

• 🐛 Report Issues
• 💡 Feature Requests
• 🤝 Contributing Guide

Links #

• GitHub Repository
• npm Package
• Documentation
• API Reference

Made with ❤️ by Pink Pixel