# codenote-codeswordsman **Repository Path**: codeSwordsman/codenote-codeswordsman ## Basic Information - **Project Name**: codenote-codeswordsman - **Description**: No description available - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-08-22 - **Last Updated**: 2026-10-17 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # CodeNote > Organize your code snippets | Professional dark UI | Trash bin safety net | Multi-device sync | Bilingual English | [简体中文](./README.md) ![version](https://img.shields.io/badge/version-v1.0.7-2668C9?style=flat-square) ![license](https://img.shields.io/badge/license-LGPL%20v3-2668C9?style=flat-square) ![platform](https://img.shields.io/badge/platform-Windows-2668C9?style=flat-square) ![language](https://img.shields.io/badge/language-16%20Syntax%20Highlights-2668C9?style=flat-square) ![sync](https://img.shields.io/badge/sync-Aliyun%20Drive%20%7C%20WebDAV%20%7C%20Local-2668C9?style=flat-square) ![backup](https://img.shields.io/badge/backup-Auto%20%7C%20Manual-2668C9?style=flat-square) [Features](#-key-features) · [Key Advantages](#-key-advantages) · [Feature Overview](#-feature-overview) · [UI Layout](#-ui-layout) · [Quick Start](#-quick-start) · [User Guide](#-user-guide) · [FAQ](#-faq) · [About Us](#-about-us) · [Feedback & Support](#-feedback--support) --- ## 📖 Introduction **CodeNote** is a professional desktop application for managing code snippets. It gathers code snippets scattered across notes, chat logs, and bookmarks into one place, organizes them by language or purpose, and lets you review and edit them anytime with a professional code editor. A built-in trash bin keeps deleted snippets recoverable, and multi-device sync keeps your code library consistent across machines. Suitable for **programmers, learners, and tech enthusiasts** to accumulate code assets over the long term. **Key highlights**: VS Code-style dark UI | 16 language syntax highlighting | Trash bin for safe delete | Snippet pinning | Export to PDF/Markdown | Multi-device sync | Bilingual interface **Official Software Name**: CodeNote by CodeSwordsman. **Store Listing Name**: CodeNote - Professional Code Snippet Manager. --- ## ✨ Key Features | Feature | Description | |---------|-------------| | 🎨 **VS Code-style dark theme** | Eye-friendly dark palette, professional look, comfortable for long coding sessions | | 🗂️ **Three-panel efficient layout** | Left categories + middle list + right editor, manage everything in one screen | | 🌈 **16 language syntax highlighting** | Python, JS/TS, HTML/CSS, SQL, Go, Rust, Java, Kotlin, C/C++/C#, Swift, Markdown & more | | 🗑️ **Trash bin safety net** | Deleted snippets go to trash first — restore, permanently delete, or clear all | | 📌 **Snippet pinning** | Pin important snippets to top with a dedicated "Pinned" virtual category | | 📤 **Multi-format export** | Export any snippet as Markdown / TXT / PDF for sharing and archiving | | ☁️ **Multi-device sync** | Aliyun Drive API / WebDAV (Nutstore, Tianyi Cloud, etc.) / Local folder — choose what fits you | | 🌍 **Bilingual interface** | One-click switch between Chinese and English; system category names follow language | | ⚡ **18 customizable shortcuts** | New, save, delete, format, line operations — all adjustable to your habits | --- ## 💪 Key Advantages - **Open Source & Free**: Licensed under LGPL v3, source code is auditable, community-driven continuous iteration - **Professional Experience**: VS Code-style dark color scheme, 16 languages with carefully tuned syntax highlighting - **Data Safety Guaranteed**: Trash bin + multiple backup + cloud sync — your code snippets will never be lost - **Lightweight & Fast**: Built on SQLite local storage, instant startup, minimal resource usage - **All-in-one Management**: Code collection, editing, formatting, export, and sync in one tool — no switching between apps - **Easy to Use**: Clean three-panel layout, zero learning curve for beginners, fully customizable shortcuts for power users --- ## 📋 Feature Overview ### A. Code Snippet Management - ➕ Full CRUD for code snippets with title / description / language tag - 🌳 Tree-style category management with multi-level nesting - 🎭 Custom category icons for visual identification - 🖱️ Drag-and-drop category reordering - 🔍 Keyword search across title, description, and content - 📌 Built-in "All Code", "Uncategorized", and "Pinned" system categories - 🗑️ **Trash bin**: deleted snippets go to trash first, with restore and permanent delete options (new in v1.0.7) - 📤 **Snippet export**: export as Markdown / TXT / PDF (new in v1.0.7) ### B. Editor Experience - 🌈 **Syntax highlighting for 16 languages**: Python, JavaScript, TypeScript, HTML, CSS, SQL, Go, Rust, Java, Kotlin, C, C++, C#, Swift, Markdown, Plain text (greatly expanded in v1.0.7) - 🔢 Line numbers for precise positioning - 🔄 Auto-indent to keep code tidy - 🧩 Bracket matching highlight for clear structure - 🎨 **One-click code formatting for 10 languages**: Python (black), JavaScript/TypeScript/HTML/CSS/JSON (jsbeautifier), Go, Shell, SQL (sqlparse), YAML (greatly expanded in v1.0.7) - 📝 Markdown live preview — see rendered result as you type - 🔍 **Find / Replace**: inline find & replace toolbar with expand/collapse toggle (new in v1.0.7) - 🔤 **Auto language detection**: automatically detects programming language when pasting code (new in v1.0.7) - ↩️ Auto-wrap toggle - 🔎 Goto line - ↪️ Undo / Redo - 📋 Line operations: delete line, move line up/down, copy line down - 💬 Toggle line comments (auto-detects comment syntax per language) ### C. Data Security - 💾 Manual backup: one-click snapshot of current data - ⏰ Auto scheduled backup: custom interval, runs silently in background - 🕒 History restore: roll back to any previous backup point - ☁️ Aliyun Drive official API sync: based on official authorization, secure and stable - 🌐 WebDAV sync: supports Nutstore, Tianyi Cloud Drive, self-hosted NAS, NextCloud, Synology, and any WebDAV server - 📁 Local folder auto-backup: just pick a path, no external account needed - 🔐 Dual storage: local backup + cloud backup, data never lost - 🗑️ Trash bin soft-delete: accidentally deleted snippets can be restored from trash (new in v1.0.7) ### D. Personalization - 🎨 VS Code-style dark theme - ⌨️ 18 customizable shortcuts - 🌍 One-click Chinese / English switch - 🎭 Category icon picker - 🖱️ Drag-and-drop category reordering - 🖼️ Frameless modern window with custom title bar ### E. Other Thoughtful Features - 🔔 Built-in version update checker, get new releases first - 💖 Usage guide and review prompt system, friendly onboarding - 🔁 System category names auto-switch with interface language ("All Code" / "全部代码") - 📂 Data stored in AppData directory for better security (optimized in v1.0.7) --- ## 🖥️ UI Layout ![Main](img/en_1.png) **Three-panel responsibilities**: - **Left category panel**: tree navigation (drag-to-reorder) + search + add button, organize your code library - **Middle snippet list**: snippet cards under current category, showing title, description, language tag; right-click to pin/export - **Right editor**: full code of the selected snippet, supports editing, formatting, find & replace, export, Markdown preview **Dark theme palette**: | Element | Color | |---------|-------| | Editor background | `#1E1E1E` | | Editor text | `#D4D4D4` | | Line number text | `#858585` | | Selected item | `#38bdf8` | | Keyword | `#569CD6` Blue | | String | `#CE9178` Orange | | Comment | `#6A9955` Green | | Number | `#B5CEA8` Light green | --- ### 📦 Download #### Method 1: Direct Download from GitHub (Recommended) - This version only supports Windows x64 - Visit the [Releases page](https://github.com/linuxday/codenote-codeswordsman/releases) to download the latest installer - Double-click to run after download, no additional configuration needed #### Method 2: Microsoft Store - One-click installation via Microsoft Store, automatic updates, safe and no bundles - Download link: ### First-time Setup Guide 1. After launch, click ➕ in the left category panel to create your first category (e.g., "Python常用", "Frontend") 2. Under the new category, click ➕ to add your first code snippet 3. Optionally click [Sync] in the title bar to configure data sync 4. Switch interface language in the bottom bar --- ## 📚 User Guide ### How to Add a Code Snippet 1. Select target category in the left panel (or pick "Uncategorized") 2. Click ➕ add button, or use shortcut (default `Ctrl+N`) 3. In the dialog, fill in: title, description, language, code content, category 4. After saving, the snippet appears in the middle list; click it to view/edit in the right editor ### How to Manage Categories - **Add category**: click ➕ in left panel, enter name and pick an icon - **Rename / Delete**: right-click a category item, choose the action - **Multi-level nesting**: right-click a parent category to add subcategories - **Custom icons**: when creating or editing a category, pick from the icon library - **Drag to reorder**: drag category items in the left panel to adjust display order (new in v1.0.7) ### How to Search Snippets - Top search box in left panel: full-text search across all snippets - Search box in middle list: search within current category - Shortcut (default `Ctrl+F`) to focus the search box quickly ### How to Configure Data Sync See the [Data Sync Details](#-data-sync-details) section. ### How to Switch Interface Language Click the language switch button in the bottom bar, choose "中文" or "English". All UI text and system category names will switch instantly without restart. ### How to Customize Shortcuts 1. Click [Shortcut Settings] in the bottom bar 2. In the settings dialog, click any action to rebind 3. Press a new key combination to bind it 4. Takes effect immediately after saving ### How to Backup and Restore **Manual backup**: click [Backup] in the title bar to create a timestamped backup point immediately **Auto backup**: enable "Auto Backup" in sync settings and set an interval **Restore data**: 1. Click [Restore] in the title bar 2. Browse the history list with time, type, and size for each backup 3. Double-click or select and click [Restore] 4. Confirm, and the app will restart to load the historical data ### How to Use the Trash Bin (new in v1.0.7) When you delete a snippet, it goes to the trash bin first instead of being permanently deleted — giving you a second chance. - **View trash**: click the [Trash] button in the title bar - **Restore a snippet**: right-click a snippet in the trash and choose "Restore" - **Permanently delete**: right-click and choose "Permanently Delete" — this cannot be undone! - **Clear trash**: click the "Clear Trash" button to permanently delete all snippets in the trash ### How to Pin Snippets (new in v1.0.7) Keep important code snippets at the top for quick access. - **Pin**: click the 📌 button at the top of the editor, or right-click a snippet in the list and choose "Pin Snippet" - **Unpin**: click the 📌 button again, or right-click and choose "Unpin" - **View pinned**: click the "Pinned" virtual category in the left panel to see all pinned snippets ### How to Export Snippets (new in v1.0.7) Export code snippets as files for sharing and archiving. 1. Open the target snippet in the editor 2. Click the [Export] button 3. Choose export format: Markdown (.md) / Plain Text (.txt) / PDF (.pdf) 4. Pick a save location — the file's folder opens automatically after export ### Default Shortcut Cheat Sheet | Action | Default Shortcut | |--------|------------------| | New snippet | `Ctrl+N` | | Save snippet | `Ctrl+S` | | Delete snippet | `Ctrl+D` | | Copy code | `Ctrl+C` | | Format code | `Ctrl+Shift+F` | | Undo | `Ctrl+Z` | | Redo | `Ctrl+Y` | | Select all | `Ctrl+A` | | Delete line | `Ctrl+Shift+K` | | Move line up | `Alt+↑` | | Move line down | `Alt+↓` | | Copy line down | `Shift+Alt+↓` | | Toggle line comment | `Ctrl+/` | | Find | `Ctrl+F` | | Goto line | `Ctrl+G` | | Toggle word wrap | `Alt+Z` | | Toggle Markdown preview | `Ctrl+Shift+V` | | New category | `Ctrl+Shift+N` | > All shortcuts can be customized in [Shortcut Settings]. --- ## ☁️ Data Sync Details CodeNote offers three sync methods — pick one or combine them: | Method | Use Case | Setup Difficulty | External Account Required | |--------|----------|------------------|---------------------------| | **Aliyun Drive API** | Multi-device cloud sync, best for China | Medium (requires developer access) | Yes (Aliyun account) | | **WebDAV** | Self-hosted NAS / Nutstore / cross-platform | Medium (server URL needed) | Yes (WebDAV service) | | **Local folder** | Same-machine backup / USB / network drive | Low (just pick a folder) | No | ### Aliyun Drive API Sync Backup data via Aliyun Drive official authorization — secure and stable. **Setup steps**: 1. Apply for Aliyun Drive developer access to get Client ID and Secret 2. Set environment variables: ```bash set ALIYUN_CLIENT_ID=your_client_id set ALIYUN_CLIENT_SECRET=your_client_secret ``` 3. In the app, click [Sync] in title bar → choose "Aliyun Drive API" → complete authorization ### WebDAV Sync Supports any standard WebDAV server. Verified compatible with: Nutstore, Tianyi Cloud Drive, self-hosted NextCloud, Synology NAS, etc. **Setup steps**: 1. Prepare WebDAV server URL, username, password 2. Click [Sync] in title bar → choose "WebDAV" 3. Fill in server URL, username, password 4. Test connection and save ### Local Folder Sync No external account needed — just point to a local path and the database file will be backed up automatically. **Setup steps**: 1. Click [Sync] in title bar → choose "Local Folder Sync" 2. Pick or type a sync folder path (e.g., USB drive, network drive) 3. Set auto-sync interval 4. Check "Enable Sync" and save --- ## ❓ FAQ **Q: Where is my data stored?** A: By default in the `%APPDATA%/majk-code/snippets_db.sqlite` file. After enabling sync, backups are pushed to the cloud or your chosen local folder. **Q: How do I switch the interface language?** A: Click the language switch button in the bottom bar, choose "中文" or "English". All UI text and system category names switch instantly — no restart needed. **Q: How much traffic does sync consume?** A: Sync only transfers the SQLite database file, typically tens of KB to a few MB per sync, depending on the total amount of snippets. **Q: Can I manually copy backup files to another computer?** A: Yes. The `.sqlite` files in the backup directory can be copied to another computer running CodeNote and loaded via the [Restore] feature. **Q: Does it support macOS / Linux?** A: Currently only Windows is officially supported. macOS / Linux do not have official releases yet, but the source code can theoretically run on those platforms (you'll need to install dependencies yourself). **Q: How do I upgrade to a new version?** A: Click [Check Update] in the title bar — the app compares version numbers and provides a download link. You can also download directly from [Releases](https://github.com/linuxday/codenote-codeswordsman/releases). **Q: Will upgrading lose my existing snippets?** A: No. Please click [Backup] before upgrading to create a backup point. After the upgrade, the new version reads the existing database file automatically — no data loss. --- ## 🗺️ Roadmap ### v1.0.7 Completed - ✅ Three-panel layout & VS Code-style dark theme - ✅ **16 language syntax highlighting** (added TypeScript, CSS, Rust, Kotlin, C/C++/C#, Swift, etc.) - ✅ **10 language code formatting** (added TypeScript, CSS, JSON, Go, Shell, YAML) - ✅ **Trash bin**: soft-delete + restore + permanent delete + clear all - ✅ **Snippet pinning**: pin important snippets to top with dedicated virtual category - ✅ **Snippet export**: Markdown / TXT / PDF formats - ✅ **Find / Replace**: inline find & replace toolbar in editor - ✅ **Auto language detection**: detect programming language on paste - ✅ **Drag-and-drop category reordering** - ✅ MVVM architecture refactor for better stability - ✅ Aliyun Drive official API sync - ✅ WebDAV sync (Nutstore, Tianyi Cloud, NextCloud, Synology, etc.) - ✅ Local folder auto-backup - ✅ History backup restore - ✅ Bilingual interface (Chinese / English) - ✅ 18 customizable shortcuts - ✅ Custom category icons - ✅ Version update checker - ✅ Data migrated to AppData directory ### Planned (Open for Discussion) - 🔜 Tag system - 🔜 Batch import / export - 🔜 More sync methods - 🔜 Snippet sharing > Feel free to share your needs and suggestions in [Issues](https://github.com/linuxday/codenote-codeswordsman/issues). --- ## 💬 Feedback & Support - **Bug reports / Feature requests**: [Submit an Issue](https://github.com/linuxday/codenote-codeswordsman/issues) - **In-app feedback**: the "Review Prompt" dialog during use - **Contact author**: 码剑客 (CodeSwordsman) If CodeNote helps you, consider leaving feedback on the [Releases](https://github.com/linuxday/codenote-codeswordsman/releases) page, or give the project a ⭐ to help more people discover it. --- ## 📄 License This project is open-sourced under the [LGPL v3](https://www.gnu.org/licenses/lgpl-3.0.html) license. --- ## 🔧 System Requirements - Windows 10 / 11 (x64) - 2GB+ RAM - 100MB+ free disk space - Internet connection (for cloud sync features) --- ## 📖 About Us
**CodeSwordsman (CSM)** is committed to developing excellent free software tools, focusing on the field of practical utilities. Upholding the principles of efficiency and convenience, we provide users worldwide with a simple, easy-to-use and reliable experience, helping them improve efficiency and simplify operations. 中文官网: English Website: --- ## 📞 Contact - Website: - GitHub: --- ## 🌟 Acknowledgements Thanks to all users who support and use CodeNote! Every piece of feedback and every Star drives us to keep improving. ©2026 CodeNote | Crafted by 码剑客 (CodeSwordsman)