Skip to content

[2.0.0] - 2025-11-24

Choose a tag to compare

@FlyNumber FlyNumber released this 24 Nov 11:49
· 22 commits to main since this release

Breaking Changes

  • Eliminated manual file copying requirement - Plugin now uses Docusaurus native APIs
  • Users upgrading from v1.x must remove manually copied theme files (src/theme/Root.js and src/components/MarkdownActionsDropdown/)
  • Component directory structure changed: src/theme/ and components/
  • Components now bundled with plugin instead of user's project

Added

  • getThemePath() plugin API to automatically provide theme components
  • .gitignore file for cleaner development experience
  • Comprehensive migration guide in README for v1.x users
  • Zero-config installation - just add plugin to docusaurus.config.js

Changed

  • Plugin now provides components via Docusaurus plugin APIs instead of requiring manual copying
  • Updated README with simplified installation instructions
  • Component imports now use relative paths instead of @site alias
  • Updated troubleshooting guide to reflect new architecture
  • Updated advanced configuration examples to use swizzling

Improved

  • Much better developer experience - no manual file management needed
  • Components automatically update when plugin updates (no stale copied files)
  • Cleaner project structure - plugin consumers don't need theme overrides
  • Standard Docusaurus plugin pattern - follows best practices

Technical Details

  • Uses Docusaurus getThemePath() lifecycle method
  • Components bundled at: theme/Root.js and components/MarkdownActionsDropdown/
  • Tested in production with 58 markdown files and 10 image directories
  • Compatible with Docusaurus v3.x

Migration from v1.x

  1. Remove manually copied files: src/theme/Root.js and src/components/MarkdownActionsDropdown/
  2. Update the plugin: npm update docusaurus-markdown-source-plugin
  3. Rebuild: npm run build
  4. CSS in custom.css remains unchanged