Knot

"Knot is the thread that ties your ideas together, transforming them into a tapestry of words."

─ chatGPT 🧶

Structure

├─ apps
│  ├─ server     --Web server for both app
│  ├─ reader     --Reading stuff
│  │  ├─ web
│  │  └─ desktop
│  └─ writer     --Writing stuff
│     ├─ web
│     └─ desktop
├─ pkgs
│  ├─ editor     --Text editor core
│  ├─ config     --Common config files
│  ├─ ui         --User interface
│  ├─ ai         --AI api
│  ├─ db         --DB configs and models
│  ├─ auth       --Auth configs
│  └─ sync       --File Synchronization
├─ docs          --Documents for contributors
└─ dist          --Build output

External libraries

• css styling

  kobalte
  tailwindCSS

• editor library

  tiptap

• monorepo management tool

  turborepo

• frontend dev tool

  vite

• frontend framwork

  solid-js

• desktop app builder

  tauri

• code formater

  dprint

Formatting

pnpm lint will format all files recursively. you can find the format rules at dprint.json

Format on save

Neovim

wiki

Todo

editor

• Markdown editing
• Synchronized editing with sidebar
• Keybinding
  • Common keybinding
  • Knot keybinding
  • which-key
• Collaborative editing
  • Share link
• Persistence
• File sync
  • Local
  • Cloud
• Togglable feature
• Preview window
• Typewriter-like auto scroll
• Full-text search
  • Search and move
  • Search and paste
• Backlink
  • Graph view

UI

• Theme
• Sidebar
• Modal
• Which-key