{"id":48405734,"url":"https://github.com/g4rcez/writeme-editor","last_synced_at":"2026-05-28T00:01:14.339Z","repository":{"id":341904317,"uuid":"1037714736","full_name":"g4rcez/writeme-editor","owner":"g4rcez","description":null,"archived":false,"fork":false,"pushed_at":"2026-05-17T16:28:40.000Z","size":37859,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-17T16:37:21.712Z","etag":null,"topics":["codemirror","electron","floating-ui","reactjs","tailwindcss","tiptap","typescript"],"latest_commit_sha":null,"homepage":"https://app.writeme.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/g4rcez.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2025-08-14T02:30:29.000Z","updated_at":"2026-05-17T16:28:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"d0a2fd40-3576-409c-8bf6-7a66ee6b9d54","html_url":"https://github.com/g4rcez/writeme-editor","commit_stats":null,"previous_names":["g4rcez/writeme-editor"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/g4rcez/writeme-editor","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/g4rcez%2Fwriteme-editor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/g4rcez%2Fwriteme-editor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/g4rcez%2Fwriteme-editor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/g4rcez%2Fwriteme-editor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/g4rcez","download_url":"https://codeload.github.com/g4rcez/writeme-editor/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/g4rcez%2Fwriteme-editor/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33588345,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-27T02:00:06.184Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["codemirror","electron","floating-ui","reactjs","tailwindcss","tiptap","typescript"],"created_at":"2026-04-06T03:00:33.359Z","updated_at":"2026-05-28T00:01:14.331Z","avatar_url":"https://github.com/g4rcez.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# writeme\n\nThis is designed to be a text editor that help you to interact with AI and took notes with super powers, by using our awesome\n\n## Features\n\n- **AI-Powered Editing**: Native integration with AI for content generation, refinement, and intelligent note-taking.\n- **Markdown First**: Full Markdown support using Tiptap and Unified/Remark ecosystems.\n- **Graph Visualization**: Interactive 2D force-directed graph to visualize connections between notes and hashtags.\n- **Integrated Terminal**: Built-in terminal support (using xterm.js and node-pty) for developers.\n- **Read It Later**: Web content scraper that transforms articles into clean, readable notes.\n- **Hybrid Storage**: Support for both local filesystem (direct file access) and database-backed (Dexie/SQLite) storage modes.\n- **Rich Media \u0026 Extensions**: Support for Excalidraw, Mermaid diagrams, KaTeX math, and Shiki syntax highlighting.\n- **Cross-Platform**: Available as an Electron desktop application and a Progressive Web App (PWA).\n\n## Installation\n\n### macOS — Homebrew\n\n```bash\nbrew tap g4rcez/writeme\n```\n\n**Desktop app:**\n\n```bash\nbrew install --cask writeme\n```\n\n**CLI:**\n\n```bash\nbrew install g4rcez/writeme/writeme\n```\n\n### Other platforms\n\nDownload the latest release for your platform from the [releases page](https://github.com/g4rcez/writeme-editor/releases):\n\n| Platform | File |\n| --- | --- |\n| macOS (Apple Silicon) | `writeme-\u003cversion\u003e-arm64.dmg` |\n| macOS (Intel) | `writeme-\u003cversion\u003e-x64.dmg` |\n| Windows | `writeme-setup.exe` |\n| Linux (Debian/Ubuntu) | `writeme_\u003cversion\u003e_amd64.deb` |\n| Linux (Fedora/RHEL) | `writeme-\u003cversion\u003e.x86_64.rpm` |\n\n---\n\n## How to develop\n\nThe project uses `npm` as the preferred package manager.\n\n1. **Clone the repository**\n2. **Install dependencies**\n\n```bash\nnpm install\n```\n\n3. **Start in development mode**\n\n- For Electron:\n\n  ```bash\n  npm run dev\n  ```\n- For Browser/Web version:\n\n  ```bash\n  npm run browser:dev\n  ```\n\n## How to build\n\n### Desktop (Electron)\n\nTo package the application for your current platform:\n\n```bash\nnpm run build:package\n```\n\nTo create distributables (e.g., .deb, .exe, .zip):\n\n```bash\nnpm run make\n```\n\n#### Installing the DMG locally (macOS)\n\nThe build is ad-hoc signed, which satisfies Apple Silicon's code-signing requirement but is not notarized. macOS will quarantine the downloaded file and block the first launch. Clear the quarantine flag before opening:\n\n```bash\n# Build\nnpm run make -- --platform=darwin\n\n# Clear quarantine from the DMG before mounting\nxattr -dr com.apple.quarantine out/make/writeme.dmg\n```\n\nOpen the DMG, drag **writeme** to `/Applications`, then clear quarantine from the installed app:\n\n```bash\nxattr -cr /Applications/writeme.app\n```\n\nThe app will open normally from that point on.\n\n\u003e **Distributing to other machines** requires a paid Apple Developer ID certificate and notarization. Set `APPLE_ID`, `APPLE_APP_SPECIFIC_PASSWORD`, and `APPLE_TEAM_ID` in your environment before running `npm run make` and the build will sign and notarize automatically.\n\n### Web / PWA\n\nTo build the web version and generate PWA assets:\n\n```bash\nnpm run pwa:build\n```\n\n## Roadmap\n\nThe following features are currently planned or in development:\n\n- **Search Integration**: Full integration with TipTap Search extension.\n- **Trash System**: Implementation of a Trash/Recycle Bin for deleted notes.\n- **File Organization**: Implementation of a Folder and Notebook Tree structure in the sidebar.\n- **Enhanced Database**: Improved SQLite backend integration for desktop.\n- **Advanced Metadata**: Better support for frontmatter and note metadata.\n\n## Troubleshooting\n\n### IPC Communication\n\nIf the renderer process cannot communicate with the main process, ensure you are running in the Electron environment. Web-only features may have limited functionality compared to the desktop version.\n\n### Native Modules\n\nIf the terminal fails to start on desktop, you might need to rebuild the native `node-pty` dependency:\n\n```bash\n./node_modules/.bin/electron-rebuild\n```\n\n### Storage Mode\n\nIf files are not appearing where expected, check the \"Workspace\" setting in the dashboard or settings page to verify your current directory configuration.\n\n## LICENSE\n\nThis project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fg4rcez%2Fwriteme-editor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fg4rcez%2Fwriteme-editor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fg4rcez%2Fwriteme-editor/lists"}