Upgrade Readme
This commit is contained in:
67
README.md
67
README.md
@ -1,17 +1,32 @@
|
||||
# Project Notes
|
||||
|
||||
A lightweight, web-based Markdown note-taking application with a Go backend and a minimalist frontend built with htmx. It allows users to create, edit, delete, and search Markdown notes, with automatic front matter management and a live Markdown preview.
|
||||
A lightweight, web-based Markdown note-taking application with a Go backend and a minimalist frontend built with htmx.
|
||||
|
||||
- 🚫 No database
|
||||
- 📝 Pure Markdown with flat files
|
||||
- 🔒 Your notes, your server
|
||||
- ⌨️ Vim Mode
|
||||
- 🎹 Keyboard driven
|
||||
- 🌍 Run everywhere (Linux & FreeBSD)
|
||||
- 🛠️ Easy to build
|
||||
- 🚀 Powerful API
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
* **File-based Notes:** All notes are stored as plain Markdown files (`.md`) on the filesystem.
|
||||
* **Daily Notes:** Quick daily journaling with interactive calendar, keyboard shortcuts (`Ctrl/Cmd+D`), and structured templates.
|
||||
* **Tag Indexing:** Notes are indexed by tags specified in their YAML front matter, enabling quick search.
|
||||
* **CodeMirror 6 Editor:** Modern, powerful Markdown editor with syntax highlighting and One Dark theme.
|
||||
* **CodeMirror 6 Editor:** Modern, powerful Markdown editor with syntax highlighting, One Dark theme, and optional Vim mode.
|
||||
* **Vim Mode:** Full Vim keybindings support (hjkl navigation, modes, commands) for power users.
|
||||
* **Live Markdown Preview:** Side-by-side editor and live preview pane with scroll synchronization.
|
||||
* **Automatic Front Matter:** Automatically generates and updates `title`, `date` (creation), `last_modified`, and `tags` in YAML front matter.
|
||||
* **Slash Commands:** Insert common Markdown elements and dynamic content (like current date) using `/` commands in the editor.
|
||||
* **Search Modal:** Press `Ctrl/Cmd+K` to open a powerful search modal with keyboard navigation and real-time results.
|
||||
* **Favorites System:** Star your most important notes and folders for quick access from the sidebar.
|
||||
* **Keyboard Shortcuts:** 10+ global shortcuts for navigation, editing, and productivity (documented in About page).
|
||||
* **8 Dark Themes:** Choose from Material Dark, Monokai, Dracula, One Dark, Solarized, Nord, Catppuccin, and Everforest.
|
||||
* **Font Customization:** Select from 8 fonts (JetBrains Mono, Fira Code, Inter, etc.) with 4 size options.
|
||||
* **Interactive Calendar:** Monthly calendar widget showing daily notes with visual indicators and one-click access.
|
||||
* **Dynamic File Tree:** Automatically updating file tree in the sidebar to navigate notes.
|
||||
* **Hierarchical Organization:** Organize notes in folders with drag-and-drop file management.
|
||||
@ -179,6 +194,54 @@ Results are scored and ranked by relevance (title matches score highest).
|
||||
|
||||
**Available commands:** h1, h2, h3, list, date, link, bold, italic, code, codeblock, quote, hr, table
|
||||
|
||||
### Customization & Settings
|
||||
|
||||
Access settings by clicking the **⚙️ Paramètres** button in the sidebar.
|
||||
|
||||
**Theme Selection** (8 options):
|
||||
- Material Dark (default) - Professional Material Design theme
|
||||
- Monokai Dark - Classic Monokai palette
|
||||
- Dracula - Elegant purple and cyan accents
|
||||
- One Dark - Popular Atom theme
|
||||
- Solarized Dark - Scientifically optimized colors
|
||||
- Nord - Arctic blue-toned theme
|
||||
- Catppuccin - Pastel comfort palette
|
||||
- Everforest - Nature-inspired green and beige
|
||||
|
||||
**Font Customization**:
|
||||
- **Fonts**: JetBrains Mono (default), Fira Code, Inter, Poppins, Public Sans, Cascadia Code, Source Code Pro, Sans-serif
|
||||
- **Sizes**: Small (14px), Medium (16px), Large (18px), X-Large (20px)
|
||||
|
||||
**Editor Settings**:
|
||||
- **Vim Mode**: Enable full Vim keybindings in CodeMirror
|
||||
- hjkl navigation, insert/normal/visual modes
|
||||
- All standard Vim commands and motions
|
||||
- Requires `@replit/codemirror-vim` package
|
||||
|
||||
### Keyboard Shortcuts
|
||||
|
||||
Press `Ctrl/Cmd+K` or visit the **About** page (ℹ️ button in sidebar) for the complete list:
|
||||
|
||||
- `Ctrl/Cmd+K` - Open search
|
||||
- `Ctrl/Cmd+S` - Save note
|
||||
- `Ctrl/Cmd+D` - Open daily note
|
||||
- `Ctrl/Cmd+N` - Create new note
|
||||
- `Ctrl/Cmd+H` - Go home
|
||||
- `Ctrl/Cmd+B` - Toggle sidebar
|
||||
- `Ctrl/Cmd+,` - Open settings
|
||||
- `Ctrl/Cmd+P` - Toggle preview
|
||||
- `Ctrl/Cmd+Shift+F` - Create new folder
|
||||
- `Escape` - Close modals
|
||||
|
||||
### Favorites System
|
||||
|
||||
Star important notes and folders for quick access:
|
||||
|
||||
1. Hover over any note or folder in the sidebar
|
||||
2. Click the **★** icon to add/remove from favorites
|
||||
3. Access favorites from the **⭐ Favoris** section in the sidebar
|
||||
4. Favorites persist across sessions (stored in `.favorites.json`)
|
||||
|
||||
### Organizing Notes in Folders
|
||||
|
||||
1. Click the "📁 Nouveau dossier" button in the sidebar.
|
||||
|
||||
Reference in New Issue
Block a user