Releases: byteuser1977/ColaMD-extend
Release list
v.1.5.2
Release v1.5.2
Release Date: 2026-05-28
Tag: v1.5.2
Previous Version: v1.5.1
π Release Highlights
π Complete Internationalization (i18n) System
Introducing full multi-language support with automatic detection and dynamic switching:
- English & Chinese (Simplified) β Built-in language packs with auto-detection
- Desktop Menu Localization β All Electron menus fully localized
- Mobile Menu Localization β Complete Capacitor sidebar with language switcher
- Dynamic Switching β Change language anytime without restart; UI updates instantly
- Cross-process Sync β IPC bridge ensures menu and UI stay in sync
π§ Enhanced PDF Export Pipeline
Continued improvements from beta testing:
- Auto Theme Style Extraction β Automatically extracts and injects current theme styles
- Custom Print Style Support β Advanced CSS injection for specialized export needs
- Unified Plugin Style Management β Math & Mermaid plugins self-manage export styles
- Smart Error Recovery β Dynamic plugin skipping during export failures
π¨ Rendering Optimizations
- Optimized HTML Structure β Better compatibility with external tools
- Conditional Base Styles β Improved performance when using custom themes
- Fixed Custom Theme Export β Resolved Chromium CSSOM serialization issues
π± Mobile Platform Fixes
- Fixed Media Query β Corrected responsive behavior on mobile devices
β¨ New Features
Internationalization (i18n) System
Core Architecture
- Multi-language Engine (
src/renderer/i18n/index.ts)- English (
en) and Simplified Chinese (zh-CN) support - Auto-detect system locale at startup
localStoragepersistence for user preference- Dynamic locale switching with real-time UI refresh
- English (
Desktop Integration
- Electron Menu Localization (
src/main/index.ts)- All menus: File, Edit, View, Theme, Help
- Sub-menus: Undo/Redo/Cut/Copy/Paste/SelectAll, Zoom/Fullscreen
- IPC channel
set-localefor renderer β main process sync - Custom theme names preserved (no forced translation)
Mobile Integration
- Capacitor Sidebar Localization (
src/renderer/main.ts,src/renderer/index.html)- Complete sidebar menu with
updateMobileMenuI18n()function - Language selector with one-click switching
- Toast messages: Saved, Save failed, etc.
- Theme/plugin lists auto-update on language change
- Complete sidebar menu with
Cross-Process Bridge
- IPC Synchronization (
src/preload/index.ts)- Exposed
setLocale()in ElectronAPI interface - Main process rebuilds menus on locale change
- Capacitor-compatible
setLocale()for mobile
- Exposed
Supported Languages
| Code | Language | Auto-detection |
|---|---|---|
en |
English | Default |
zh-CN |
Simplified Chinese | System locale contains zh |
π§ Improvements
PDF Export Pipeline (Continued from v1.5.1)
Auto Theme Style Extraction
- Automatically extracts current theme styles when exporting
- Injects theme CSS into exported HTML/PDF documents
- Ensures visual consistency between editor preview and exported files
Unified Plugin Style Management
- Math Plugin (
math-plugin.ts):- Added clipboard/export/rendering style configuration fields
- Self-manages export styles through configuration object
- Mermaid Plugin (
mermaid-plugin.ts):- Added unified style configuration fields
- Dynamic retrieval from plugin configuration
- No more hardcoded style handling
Enhanced Error Recovery
- Dynamic plugin skipping during export (instead of hard-coded exclusions)
- Graceful degradation when individual plugins fail
- Better error logging and user feedback
Editor Core & Rendering
- Wrapped
getLiveHTML()output in<div id="write">container for better structure - Optimized rendering: only apply base element styles when not using custom themes
- Fixed custom theme print CSS extraction to avoid Chromium CSSOM serialization issues
Mobile Platform
- β
Fixed missing
screentype in media queries (mobile.css)
ποΈ Removed
- Removed outdated PDF font compensation document (
docs/PDF_FONT_COMPENSATION.md)
β οΈ Important Notices
π VSCode ColaView Extension
New companion VSCode extension available for seamless integration:
π vscode_colaview
What is vscode_colaview?
- VSCode extension to view and edit ColaMD-rendered Markdown files
- Real-time preview of math equations and Mermaid diagrams
- Seamless integration with your existing VSCode workflow
- Perfect complement to the ColaMD desktop application
Why use it?
- Preview ColaMD content without leaving VSCode
- Maintain consistency between ColaMD desktop and code editor
- Enhanced productivity for developers working with Markdown + rich content
π¬ Contact & Support
Need help? Want to contribute? Have feedback?
π± Feishu (Lark) Contact: Scan the QR code below to add the project maintainer:
Contact: ζ―ηΉε€§δΊΊ (Byte Chain)
π¦ Installation & Upgrade
From Source
# Clone the repository
git clone https://github.com/byteuser1977/ColaMD-extend.git
cd ColaMD-extend
# Checkout v1.5.2
git checkout v1.5.2
# Install dependencies
npm install
# Run development mode
npm run dev
# Build for production
npm run buildDownload Pre-built Binaries
Visit the Releases page to download pre-built binaries for your platform:
- macOS (
.dmg) β Intel + Apple Silicon - Windows (
.exe) β Installer + Portable - Linux (
.AppImage,.deb) β Universal + Debian/Ubuntu - Android (
.apk) β Via Capacitor 6 - iOS (`.ipa**) β Via Capacitor 6 (requires TestFlight/App Store distribution)
Using Custom Themes
# Option 1: Place theme file manually
cp your-theme.css ~/.colamd/themes/
# Option 2: Import via ColaMD UI
# Open ColaMD β Theme β Import Theme β Select your .css fileAvailable themes can be downloaded from the themes/ directory or the dedicated ColaMD-themes repository.
π Migration Guide (from v1.5.1)
For Desktop Users
No breaking changes. Simply update to v1.5.2:
- Your existing settings and themes are preserved
- New i18n features are automatically available after update
- Language auto-detects based on system locale; can be changed manually
- No configuration changes required
For Mobile Users
If you were using v1.5.1:
- Direct update recommended (no need to uninstall)
- New features: Full i18n support, improved export pipeline, bug fixes
- Your data is preserved (stored in app sandbox)
For Theme Developers
- Review the updated
theme-paradigm.mddocument (v3.2) - Use
template.cssas starting point - Note the px unit unification requirement (no more pt/rem mixing)
- Consider submitting your theme to ColaMD-themes repo
π Statistics
Code Changes
- Files Changed: 30+
- Lines Added: ~1,800+
- Lines Modified: ~600+
New Features
- Internationalization system: Complete i18n architecture
- Supported languages: 2 (English, Chinese Simplified)
- Localized components: Desktop menus, Mobile sidebar, Toast messages
Test Coverage
- Bug Fixes: 10+
- Platform Fixes: Mobile media query
- Documentation: Updated
Supported Platforms
- β macOS (Intel + Apple Silicon)
- β Windows (x64)
- β Linux (x64, ARM64)
- β Android (ARM64, ARMv7)
- β iOS (ARM64)
π Acknowledgments
Special Thanks To
- Internationalization Community β For i18n best practices and patterns
- Mermaid.js Team β For the excellent diagram rendering library
- KaTeX Team β For the fast math typesetting engine
- Capacitor Team β For enabling cross-platform mobile support
- Milkdown Team β For the WYSIWYG Markdown editor framework
- ProseMirror Team β For the robust rich text editing foundation
- Electron Team β For the cross-platform desktop framework
- Vite Team β For the blazing-fast build toolchain
- Testing Community β Beta testers who provided valuable feedback on v1.5.2-beta.0
π Changelog
For detailed change history, see CHANGELOG.md.
Key changes since v1.5.1:
- v1.5.2-beta.0: Initial i18n implementation, PDF export refactor, mobile fixes
- v1.5.2 (stable): Complete internationalization, production-ready, documentation updated
π Links
- Homepage: GitHub Repository
- Documentation: README.md | README_CN.md
- Changelog: CHANGELOG.md
- Theme Repository: ColaMD-themes
- VSCode Extension: vscode_colaview π
- Issue Tracker: GitHub Issues
- Discussions: GitHub Discussions
π License
Th...
v.1.5.1
Release v1.5.1
Release Date: 2026-05-23
Tag: v1.5.1
Previous Version: v1.5.0
π Release Highlights
π¨ Enhanced Theme System
Introducing 5 new themes and a complete theme development framework:
- π Academic Paper Theme β GB/T 7713 compliant academic paper formatting
- π¨π Swiss Design Theme β International Typographic Style with black-white-red color system
- π¨ Pixso Design Theme β Modern design system styling
- π² Forest Ink Theme β Warm paper base with forest green accents
- π Standardized Template β Reference implementation for custom theme creation
π± Mobile Platform Support
Full Android (.apk) + iOS (.ipa) support via Capacitor 6:
- Native file picker integration
- Chinese IME optimization
- PDF export with native PrintManager
- Mobile-adapted responsive UI
π§ Refactored Export Pipeline
Completely rewritten PDF/HTML export system:
- Auto-extraction of current theme styles
- Plugin-injected export styles (no more hardcoded handling)
- Smart error recovery with dynamic plugin skipping
- Custom print style support for advanced use cases
β¨ New Features
Themes (5 New)
| Theme | File | Description |
|---|---|---|
| Academic Paper | academic-paper.css |
GB/T 7713 compliant, SimHei/SimSun typography, three-line tables, print-optimized Mermaid |
| Academic Paper (PT) | academic-paper-pt.css |
Same as above but using pt units for specific print scenarios |
| Swiss Design | swiss-design.css |
Black-white-red color system, geometric sans-serif fonts, grid-based layout |
| Pixso Design | pixso-design.css |
Modern design system style |
| Forest Ink | forest-ink.css |
Warm paper base, forest green ink text and accents |
| Template | template.css |
Standardized reference implementation following v3.0 paradigm |
Theme Development Framework
- Theme Paradigm Document (
docs/theme-paradigm.md) β Complete CSS theme development specification (v3.2)- Design principles: variable-driven, modular, semantic naming, AI-agent derivable
- 30+ verifiable rules (MUST / MUST NOT / SHOULD) with WCAG contrast formulas
- Print fidelity specifications: variable re-declaration, 12-category element coverage list
- px unit unification standard to ensure consistent PDF export font sizes
Mobile Platform
- Android Platform (
mobile.css)- Capacitor 6 integration for native APK builds
- File picker via
@capawesome/capacitor-file-picker - IME input method optimization for CJK languages
- Native PDF export using Android PrintManager
- iOS Platform
- Capacitor 6 integration for native IPA builds
- Full iOS support with WebView/WKWebView
- Dual-platform Bridge (
capacitor-api.ts)- Runtime auto-detection of Electron/Capacitor APIs
- Seamless code sharing between desktop and mobile
Documentation & Demo
- Academic Paper Demo (
academic-demo.md) β Real-world academic paper with 8 Mermaid diagram groups - Inline SVG Guide (
demo.html) β Best practices for SVG in Markdown - General Feature Demo (
demo.md) β Complete feature showcase
π§ Improvements
PDF Export Pipeline (Major Refactor)
Auto Theme Style Extraction
- Automatically extracts current theme styles when exporting
- Injects theme CSS into exported HTML/PDF documents
- Ensures visual consistency between editor preview and exported files
Unified Plugin Style Management
- Math plugin (
math-plugin.ts): Added clipboard/export/rendering style configuration fields - Mermaid plugin (
mermaid-plugin.ts): Added unified style configuration - Replaced all hardcoded style handling with dynamic retrieval from plugin configuration
- Plugins now self-manage their export styles through configuration objects
Enhanced Error Recovery
- Dynamic plugin skipping during export (instead of hard-coded exclusions)
- Graceful degradation when individual plugins fail
- Better error logging and user feedback
Custom Theme Export Fix
- Fixed Chromium CSSOM serialization issues for custom themes
- Proper extraction of
@media printrules from custom theme CSS - Auto-injection of custom theme print styles into export HTML
Editor Core & Rendering
- Wrapped
getLiveHTML()output in<div id="write">container for better structure - Optimized rendering: only apply base element styles when not using custom themes
- Removed debug auto-open developer tools code from production build
- Optimized academic paper theme styles for better performance
Theme System Architecture
- Modular Refactoring: Split into
foundation.css+base/built-in themes +components/mermaid/variable mapping + user theme directory - Mermaid Variable System: 20 core CSS variables (
--mermaid-*) auto-mapped to 22 chart type SVG selectors - Academic Paper Theme Refactoring: All hardcoded colors β
var()variables; allptunits βpxeven integers
π Bug Fixes
TypeScript Type System (15 Errors Fixed)
| File | Issue | Fix |
|---|---|---|
capacitor-api.ts |
string | null type assignment error |
Corrected type annotation |
editor.ts |
remarkPluginsCtx type mismatch |
Fixed type compatibility |
editor.ts |
rootEl null check missing |
Added null safety check |
math-plugin.ts |
$NodeSchema type vs $view function |
Resolved type conflict |
mermaid-plugin.ts |
Mermaid theme type issue | Fixed type definition |
mermaid-plugin.ts |
$NodeSchema type mismatch |
Aligned type interfaces |
main.ts |
Missing Vite client types for import.meta.glob |
Added type reference |
main/index.ts |
Invalid fs.createServer import |
Removed non-existent import |
main/index.ts |
Invalid PrintToPDFOptions.marginType |
Removed deprecated property |
Project Configuration Updates:
- Added
"composite": truetotsconfig.main.json,tsconfig.preload.json,tsconfig.renderer.jsonfor proper project references
Mermaid Diagram Rendering
Fixed in elegant + academic-paper themes:
- β Text offset problem resolved
- β Variable name mismatch corrected
- β Double border display issue fixed
Mermaid Theme System Improvements:
- Adjusted to Guizang warm color palette (cream background + brown tones)
- Font size optimized to 10.5pt for academic printing
- Added Typora compatible selectors (
.md-diagram-panel) - Added mobile responsive adaptation
- Unified text color and border styles across all themes
Theme Print Fidelity
Critical Fix: Completed @media print screen attribute mirrors for template and Swiss Design CSS:
Covered attributes:
- Font size (
font-size) - Line height (
line-height) - Font family (
font-family) - Borders (
border,border-*) - Spacing (
margin,padding,gap) - Letter spacing (
letter-spacing) - Word spacing (
word-spacing) - Text alignment (
text-align) - Background colors (
background,background-color) - And more...
Result: Screen preview now matches PDF export exactly.
Custom Theme Export (theme-manager.ts):
- Fixed CSS extraction logic to avoid Chromium CSSOM serialization issues
- Added automatic injection of custom theme print styles during export
Android Platform Fixes
Chinese IME (Input Method Editor)
- β
Removed
e.preventDefault()inbeforeinputevent - β Enhanced ProseMirror editor IME composition event handling
- β
Applied
-webkit-user-modify: read-write-plaintext-onlyfor better CJK input experience
Intent File Opening
- β
Added
Intent.ACTION_VIEWhandling inMainActivity - β
Supported
onNewIntentfor opening new files while app is running - β Implemented JavaScript bridge to pass file content to WebView
PDF Export on Android
- β
Replaced Capacitor Plugin bridge with
JavascriptInterface - β
Created
ColaMDNativeBridgeclass for nativePrintManagercalls - β Added "Save as PDF" option
- β Fixed pagination issues
- β Fixed save button functionality
- β Updated Mermaid version for mobile compatibility
- β Resolved layer residue problems
Export Functionality Improvements
PDF/HTML Export:
- β Refactored Mermaid rendering logic with export sync wait mechanism
- β Supported real-time rendered content export (not just source code)
- β Fixed default filename logic
File Manager Open Mechanism:
- β
Adopted pull model: JS actively calls Java
checkPendingFile() - β Eliminated JS event injection timing issues
- β Added init detection + setInterval polling dual guarantee
Mobile Adaptation
- β
Fixed missing
screentype in media queries (mobile.css)
Plugin System
- β Fixed plugin import errors
- β Updated package versions
- β Decoupled plugin system: reduced main.ts dependency on specific plugins
β οΈ Important Notices
π Theme Migration to Dedicated Repository
Starting from **v1.5.1...
v1.5.1-beta2
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog,
and this project adheres to Semantic Versioning.
[1.5.1-beta.2] - 2026-05-22
Fixed
TypeScript Type Errors
- Fixed 15 TypeScript type errors across the codebase:
capacitor-api.ts: Fixedstring | nulltype assignment erroreditor.ts: FixedremarkPluginsCtxtype mismatch androotElnull checkmath-plugin.ts: Fixed$NodeSchematype compatibility with$viewfunctionmermaid-plugin.ts: Fixed Mermaid theme type and$NodeSchematype issuesmain.ts: Added Vite client types reference forimport.meta.globmain/index.ts: Removed invalidcreateServerimport fromfsandmarginTypefromPrintToPDFOptions
TypeScript Project Configuration
- Added
"composite": trueto all TypeScript project configurations for proper project references:tsconfig.main.jsontsconfig.preload.jsontsconfig.renderer.json
Changed
Mermaid Theme System Refactor
- Restructured Mermaid styles to warm color palette:
- Changed Mermaid color scheme to Guizang warm tones (cream background + brown tones)
- Adjusted font size to 10.5pt for academic printing compatibility
- Added Typora compatible selectors (
.md-diagram-panel) - Added mobile responsive adaptation
- Unified text color and border styles
Theme System Architecture
- New modular theme architecture:
src/renderer/editor/plugins/themes/β New theme manager and base stylesthemes/base/β Base theme CSS files (light, dark, elegant, newsprint)themes/components/mermaid/β Mermaid-specific theme CSS filesfoundation.cssβ Shared foundation stylesvariables.cssβ CSS variables for Mermaid theming
Added
New Themes
- Academic Paper theme:
academic-paper.css- Mermaid color scheme in Guizang warm tones (cream background + brown tones)
- Font size optimized for academic printing (10.5pt)
- Typora compatible selectors (
.md-diagram-panel) - Mobile responsive adaptation
- Pixso Design theme:
pixso-design.css - Swiss Design theme:
swiss-design.cssπ¨π- Pure black-white-red color system inspired by Swiss International Typographic Style
- Geometric sans-serif fonts (Helvetica / Inter), grid-based layout with generous whitespace
- Form follows function design philosophy, minimal and restrained aesthetic
- Complete Mermaid diagram integration with monochrome + accent red styling
Theme Development Framework
-
Theme paradigm document:
docs/theme-paradigm.md- Comprehensive CSS theme development specification (v3.0)
- Design principles: variable-based, modular, semantic naming, AI-agent derivable
- Mandatory design constraints with validation methods (MUST / MUST NOT / SHOULD levels)
- Color space specification: 5 seed colors + 3 font stacks auto-derivation system
- Print fidelity requirements:
@media printas screen style mirror enhancement
-
Standardized theme template:
themes/template.css- Reference implementation following the v3.0 paradigm
- All required sections: design tokens, editor styles, code blocks, blockquotes, tables, Mermaid variables, print styles
- Ready-to-use template for creating new custom themes
Documentation Updates
- Updated README.md and README_CN.md to include Swiss Design theme in the downloadable themes table
- Added comprehensive theme descriptions for all 7 external themes (elegant, guizang, forest-ink, academic-paper, pixso-design, swiss-design, template)
[1.5.1-beta.1] - 2026-05-22
Added
Android Platform Support
- Full Android platform support: Integrated Capacitor 6 for native Android app builds
- File picker functionality: Integrated
@capawesome/capacitor-file-pickerplugin for file selection on Android devices - Mobile responsive styles: Added
mobile.cssfor optimized mobile display and interaction - Auto-generated app icons: Added
generate-icons.jsscript to auto-generate Android/iOS icons at various sizes- Android mipmap icons (48px-192px)
- Android adaptive icon foreground layer (108px-432px)
- iOS AppIcon (1024x1024)
New Themes & Styles
- Forest Ink slide theme: Added forest ink color scheme slide template with full presentation logic and responsive layout
- Academic Paper theme: Added
academic-paper.csstheme- Mermaid color scheme in Guizang warm tones (cream background + brown tones)
- Font size optimized for academic printing (10.5pt)
- Typora compatible selectors (
.md-diagram-panel) - Mobile responsive adaptation
- Pixso Design theme: Added
pixso-design.csstheme
Fixed
Android Platform Fixes
- Chinese IME (Input Method Editor) fix:
- Removed
e.preventDefault()inbeforeinputevent to resolve CJK input method issues - Enhanced ProseMirror editor IME composition event handling
- Used
-webkit-user-modify: read-write-plaintext-onlyto improve input experience
- Removed
- Intent file open fix:
- Added
Intent.ACTION_VIEWhandling inMainActivity - Supported
onNewIntentfor opening new files when app is already running - Passed file content to WebView via JavaScript events
- Added
- PDF export fix:
- Replaced Capacitor Plugin bridge with
JavascriptInterface - Added
ColaMDNativeBridgeclass to call Android nativePrintManager - Added "Save as PDF" option
- Fixed pagination, save button, mermaid version, and layer residue issues
- Replaced Capacitor Plugin bridge with
Export Functionality Improvements
- PDF/HTML export:
- Refactored Mermaid rendering logic with export sync wait mechanism
- Supported real-time rendered content export
- Fixed default filename logic
- File manager open:
- Adopted pull model: JS actively calls Java
checkPendingFile()to query - Eliminated JS event injection timing issues
- Added init detection + setInterval polling for dual guarantee
- Adopted pull model: JS actively calls Java
Changed
- Mobile IME handling refactor:
- Simplified mobile CSS styles, removed outdated Android IME patches
- Refactored Android file open event listener, using new
colamd-open-eventinstead of oldintent-file-opened
- Close button style optimization: Replaced rectangle rotation icon with standard cross line icon for more consistent visual effect
- Theme style updates:
mermaid-plugin.css: Minor adjustmentsforest-ink.css: Updated forest ink theme
Documentation
- Added
demo.mdanddemo.pdfdemo documents - Updated README and README_CN.md with export documentation and new doc paths
- Added mobile support documentation with tech stack, build/release workflow, and troubleshooting
- Added Forest Ink theme documentation
Dependencies
| Package | Version | Purpose |
|---|---|---|
| @capawesome/capacitor-file-picker | ^6.2.0 | Android file picker plugin |
| sharp | ^0.34.5 | Icon generation tool |
[1.5.1] - 2026-05-18
Added
Capacitor 6 β Mobile Platform Support (Cross-Platform Extension)
- Capacitor 6 integration for building native Android (.apk) and iOS (.ipa) apps
- Platform bridge layer (
capacitor-api.ts): Full replacement of Electron IPC with Capacitor native plugins- Filesystem plugin for file read/write on mobile devices
- Share plugin for content sharing and export
- App plugin for lifecycle management and deep linking
- Status bar plugin for mobile UI integration
- Haptics plugin for tactile feedback support
- Auto-detection runtime:
window.electronAPI || createCapacitorAPI()β seamless switching between desktop (Electron) and mobile (Capacitor) environments - Mobile responsive UI (
mobile.css):- Touch-optimized interactions with
-webkit-tap-highlight-color: transparent - Safe area insets support (
env(safe-area-inset-*)) for notched devices - Responsive breakpoints: 768px (tablet), 480px (phone)
- Optimized font sizes, padding, and scroll behavior for mobile screens
- Context menu adaptation for touch interfaces
- Touch-optimized interactions with
Android Platform Configuration
- Android project initialized at
android/with Gradle build system - File association: Registered
.md/.markdownfile handlers inAndroidManifest.xml - Storage permissions:
READ_EXTERNAL_STORAGE,WRITE_EXTERNAL_STORAGE,MANAGE_EXTERNAL_STORAGE - Network security config: Cleartext traffic allowed for local development
- Soft input mode:
adjustResizefor proper keyboard handling in editor - 5 Capacitor plugins auto-detected: @capacitor/app, filesystem, haptics, share, status-bar
iOS Platform Configuration
- Xcode project initialized at
ios/with CocoaPods dependency management - Requires Xcode + CocoaPods for full build (pod install)
- Web assets synced to
ios/App/App/public/
Build Scripts & Workflow
- New npm scripts for Capacitor development workflow:
| Script | Purpose |
|---|---|
npm run cap:sync |
Sync web assets to native platforms |
npm run cap:open:android |
Open in Android Studio |
npm run cap:open:ios |
Open in Xcode |
npm run cap:run:android |
Build β Sync β Run on Android device/emulator |
npm run cap:run:ios |
Build β Sync β Run on iOS simulator |
npm run cap:build:android |
... |
