README.md

➤ Mine Knowledge MMA

A modern and efficient personal knowledge management system built with Electron and Vue.js.

Download • Features

🛠 Tech Stack

Category	Technologies
Framework
UI
State Management
Development

✨ Features

Feature	Description
📝 Markdown Support	Full markdown editing and preview with code highlighting
🗂 File Management	Organize your knowledge with folders and files
🔍 Quick Search	Fast and efficient search through all your notes
📱 Multi-language	Support for English and Traditional Chinese
🌙 Dark Mode	Built-in dark mode for comfortable night viewing
🖼 Image Support	Drag & drop image upload with automatic optimization
⭐ Favorites	Mark and quickly access your most important notes
🗑 Trash System	Safely delete and restore notes when needed
📋 Templates	Create notes from predefined templates
📊 History Tracking	Track your recent note modifications
🔄 Auto Save	Automatic saving of your work
💾 Local Storage	All data stored locally for privacy
🔄 Translation	Translate text between multiple languages

🚀 Getting Started

System Requirements

Requirement	Version
Node.js	v16.0.0 or higher
npm/yarn	Latest stable version
Git	Latest stable version

🛠️ Development Setup

Clone the repository

git clone https://github.com/yeongpin/mine-knowledge-mma.git

Navigate to the project directory

cd mine-knowledge-mma

Install dependencies

npm install

Start the development server

npm run dev

📦 Build Commands

Build for production

npm run build

📁 Project Structure

mine-knowledge-mma/
├── src/
│ ├── main/          # Main process files
│ ├── preload/       # Preload scripts
│ └── renderer/      # Frontend Vue.js files
│   ├── components/  # Vue components
│   ├── stores/      # Pinia stores
│   └── locales/     # i18n translations
├── public/          # Static assets
└── dist/           # Build output

🤝 Contributing

Contributions are welcome! Please read our Contributing Guide for details on our code of conduct and the process for submitting pull requests.

📄 License

This project is licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License - see the LICENSE file for details.

🙏 Acknowledgments

• Electron - For the amazing desktop framework
• Vue.js - For the progressive JavaScript framework
• Element Plus - For the beautiful UI components
• All our contributors

---

Made with ❤️ by yeongpin