zhitongblog/solomd:README 来源编辑指南
基于 README、仓库元数据和许可证整理 zhitongblog/solomd 的安装与核验路径。
项目定位
zhitongblog/solomd 的 README 将项目描述为"A markdown editor , and the bridge to your LLM. Local-first, MIT, 15 MB. Bundled MCP server lets Claude Code / Codex / Cursor drive your vault directly. 14 AI providers BYOK."。本文只整理仓库能直接核验的内容,不把星标、Fork 或宣传语当成质量证明。README 在"SoloMD"下的说明是:Your notes live in a folder. SoloMD is the editor on top , with a first-class agent surface inside the editor, and the MCP endpoint Claude Code / Cursor can drive from outside. Same .md files. Chat with your vault.。这给出的首先是项目边界,而不是已经完成的生产验证。
适用场景
从 README 的"New in 4.6 , the knowledge-graph layer"和相关条目看,读者可以先判断它是否解决自己的具体问题:Type-driven sidebar , give a note type: Project and its members become a first-class collapsible section with custom icon/colour/columns (types-as-lenses).。如果你的目标与这段说明不一致,就不应仅凭项目热度采用它。这里保留原项目名、命令和组件名,方便回到一手来源核对。 README 还列出了另一条可核对的信息:Properties inspector (⌘⇧I) , edit YAML frontmatter with type/date/status/relation pickers; line-surgical writes preserve your comments, inline arrays and quoting byte-for-byte.。这类原文条目可以帮助读者设计试运行步骤,但不能代替自己的环境测试。
工作方式
README 把工作方式分散写在"New in 4.6 , the knowledge-graph layer"等段落中。可确认的线索包括:The structural half Obsidian and Tolaria had and SoloMD didn't , now built, and on SoloMD's own warm design system:。这篇整理没有把未写出的架构、性能或安全边界补成结论;真正的运行链仍应结合仓库目录、配置文件和版本标签检查。
安装与第一次运行
第一次安装应从 README 给出的入口开始。当前可复核的命令是: brew install --cask zhitongblog/solomd/solomd 如果仓库没有提供命令,本文不会替它编造安装步骤,而是建议先打开 README 的"New in 4.6 , the knowledge-graph layer"部分,确认系统依赖、默认端口和首次初始化动作。
配置与日常使用
日常使用的细节取决于项目实际文档。README 的"New in 4.6 , the knowledge-graph layer"段落提到:Plus a unified macOS title bar (traffic lights inline in the toolbar) and a from-scratch design-system + Vue component library. Still 15,32 MB, still free, still local-first. → Compare vs Obsidian / Typora / Tolaria。对于配置文件、环境变量、权限和数据目录,当前稿只记录来源明确的部分;未写明的默认值必须在测试环境中验证,并保留可回滚的配置副本。 同一部分还提到:Typed relationships , belongsto / relatedto / has frontmatter with automatic inverses, resolved server-side for big vaults.。