This repository has been archived on 2026-04-03. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
core/packages/notes/README.md
Jeffrey Smith db9d630399
All checks were successful
CI/CD / detect-changes (pull_request) Successful in 3s
CI/CD / test-frontend (pull_request) Successful in 5s
CI/CD / test-go-pg (pull_request) Successful in 2m37s
CI/CD / test-sqlite (pull_request) Successful in 2m45s
CI/CD / build-and-deploy (pull_request) Successful in 1m32s
Feat v0.4.5 editor modes + document outline
Tri-state viewMode (rendered/edit/split) replaces binary preview toggle.
Split view uses CSS grid with synced scroll. Document outline panel parses
headings and supports click-to-scroll in both CM6 and preview. Mode
preference persisted to localStorage. Notes package bumped to v0.6.0.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-29 20:40:22 +00:00

54 lines
1.3 KiB
Markdown

# Notes
Markdown notes surface with sidebar navigation, live preview, and search.
## Status: v0.1.0
Core CRUD with markdown textarea and inline preview.
## Features
- Create, edit, archive notes
- Markdown editing with live preview toggle
- Auto-save with debounce (1s)
- Pin important notes to top
- Full-text search across title and body
- Light/dark theme support
## Planned
- v0.4.1: Folders + navigation tree
- v0.4.2: Tags + enhanced search
- v0.4.3: Backlinks + `[[wikilinks]]`
- v0.4.4: Rich editor (CodeMirror 6) + import/export
- v0.4.5: Editor modes (rendered/edit/split) + document outline
## Data
Single `notes` table in ext_data:
| Column | Type | Description |
|--------|------|-------------|
| title | text | Note title |
| body | text | Markdown content |
| folder_id | text | Folder reference (v0.4.1) |
| pinned | int | 0 or 1 |
| archived | int | Soft delete flag |
## API
| Method | Path | Description |
|--------|------|-------------|
| GET | /notes | List notes (lightweight, no body) |
| POST | /notes | Create note |
| GET | /notes/:id | Get note with full body |
| PUT | /notes/:id | Update note |
| DELETE | /notes/:id | Archive (or hard delete with ?hard=1) |
| GET | /search?q=term | Search title and body |
| GET | /stats | Note counts |
## Keyboard Shortcuts
- `Ctrl/Cmd+S` — Force save
- `Tab` — Insert two spaces