added more docs
This commit is contained in:
parent
0922af3c64
commit
59c510f193
17
README.md
17
README.md
|
|
@ -64,26 +64,11 @@ NoteDiscovery is a **lightweight, self-hosted note-taking application** that put
|
||||||
- 🧮 **Math Support** - LaTeX/MathJax for beautiful equations
|
- 🧮 **Math Support** - LaTeX/MathJax for beautiful equations
|
||||||
- 📄 **HTML Export & Print** - Export notes as standalone HTML or print
|
- 📄 **HTML Export & Print** - Export notes as standalone HTML or print
|
||||||
- 🕸️ **Graph View** - Interactive visualization of connected notes
|
- 🕸️ **Graph View** - Interactive visualization of connected notes
|
||||||
- ✏️ **Drawing editor** - In-app canvas for sketches and annotations saved as `drawing-*.png` — **see the next section**
|
- ✏️ **Drawing editor** - In-app sketches as `drawing-*.png` next to your notes — see [documentation/DRAWING.md](documentation/DRAWING.md)
|
||||||
- ⭐ **Favorites** - Star your most-used notes for instant access
|
- ⭐ **Favorites** - Star your most-used notes for instant access
|
||||||
- 📑 **Outline Panel** - Navigate headings with click-to-jump TOC
|
- 📑 **Outline Panel** - Navigate headings with click-to-jump TOC
|
||||||
- 🤖 **AI Assistant Ready** - MCP integration for Claude, Cursor & more
|
- 🤖 **AI Assistant Ready** - MCP integration for Claude, Cursor & more
|
||||||
|
|
||||||
## ✏️ Drawing editor
|
|
||||||
|
|
||||||
NoteDiscovery isn’t only markdown—you can **sketch, diagram, and mark up ideas** without a separate app. Use **+ New → New drawing** in the sidebar: the app creates a **`drawing-{timestamp}.png`** in the folder you choose, next to your `.md` files. Open it from the tree like any image; files named `drawing-*.png` open in the **drawing viewer** instead of the static image viewer.
|
|
||||||
|
|
||||||
**What you get**
|
|
||||||
|
|
||||||
| | |
|
|
||||||
|--|--|
|
|
||||||
| **Tools** | Pencil, line, rectangle, ellipse, **eraser** (paints with the canvas background), **eyedropper** (sample color from the pixel under the cursor), **clear** (replace with a blank white image—confirmed, then saved). |
|
|
||||||
| **Toolbar** | Color picker and stroke width next to the tools; main bar still has **undo/redo** for strokes when the drawing is focused. |
|
|
||||||
| **Saving** | **Autosave** shortly after you release the pointer from a stroke; **Ctrl+S** / **Cmd+S** saves the PNG immediately (same key as saving a note). |
|
|
||||||
| **On disk** | Ordinary PNG files—embed in notes with `![]()`, version in Git, back up with the rest of your vault. |
|
|
||||||
|
|
||||||
> 📖 **Reference:** [documentation/DRAWING.md](documentation/DRAWING.md) · Also covered in [FEATURES.md](documentation/FEATURES.md)
|
|
||||||
|
|
||||||
## 🤖 AI-Powered Note Management
|
## 🤖 AI-Powered Note Management
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,7 @@
|
||||||
- **Public Sharing** - Share notes via token-based URLs with optional QR code for mobile (see [SHARING.md](SHARING.md))
|
- **Public Sharing** - Share notes via token-based URLs with optional QR code for mobile (see [SHARING.md](SHARING.md))
|
||||||
|
|
||||||
### Media Support
|
### Media Support
|
||||||
- **Drawing editor** - Create and edit **`drawing-*.png`** sketches next to your notes (pencil, shapes, eraser, eyedropper, autosave); see [DRAWING.md](DRAWING.md)
|
- **Drawing editor** — In-app **`drawing-*.png`** sketches next to your notes ([overview](#drawing-editor)); full guide: **[DRAWING.md](DRAWING.md)**
|
||||||
- **Drag & drop upload** - Drop files from your file system directly into the editor
|
- **Drag & drop upload** - Drop files from your file system directly into the editor
|
||||||
- **Clipboard paste** - Paste images from clipboard with Ctrl+V
|
- **Clipboard paste** - Paste images from clipboard with Ctrl+V
|
||||||
- **Images** - JPG, PNG, GIF, WebP (default max 10MB, configurable)
|
- **Images** - JPG, PNG, GIF, WebP (default max 10MB, configurable)
|
||||||
|
|
@ -43,6 +43,16 @@
|
||||||
- **Theme-aware** - Export uses your current theme for consistent appearance
|
- **Theme-aware** - Export uses your current theme for consistent appearance
|
||||||
- **Full rendering** - MathJax equations, Mermaid diagrams, and syntax highlighting included
|
- **Full rendering** - MathJax equations, Mermaid diagrams, and syntax highlighting included
|
||||||
|
|
||||||
|
## ✏️ Drawing editor
|
||||||
|
|
||||||
|
Sketch beside your notes without leaving NoteDiscovery. **+ New → New drawing** creates a **`drawing-{timestamp}.png`** next to your markdown files; those open in the drawing viewer, other images open as usual.
|
||||||
|
|
||||||
|
- **Tools** — Pencil, lines, rectangles, ellipses, eraser, eyedropper, clear; color and stroke width on the toolbar; undo/redo while you work.
|
||||||
|
- **Saving** — Autosave and **Ctrl+S** / **Cmd+S** like the rest of the app.
|
||||||
|
- **Files** — Plain PNGs in your vault—link them in notes and back them up with everything else.
|
||||||
|
|
||||||
|
For file naming, API notes, and more: **[DRAWING.md](DRAWING.md)**
|
||||||
|
|
||||||
## 🔗 Linking & Discovery
|
## 🔗 Linking & Discovery
|
||||||
|
|
||||||
### Graph View
|
### Graph View
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue