登录 注册

foam

去点 Star
效率与办公工具内容创作与媒体工具开发者工具 graph-visualisationmarkdownmarkdown-editornote-takingnotes-apppersonal-knowledge-base
17,479
Stars
791
Forks
114
Watchers
25
Open Issues
NOASSERTION
许可证
TypeScript
语言
2020-06-19
创建时间
2026-11-12
最近更新

项目能做什么

基于 VSCode 的个人知识管理与分享系统。
来源：AI 基于仓库事实生成 · 内容以仓库实际 README 为准

使用说明 查看原始 README 原仓库文档

中文使用说明暂未生成。下面保留原仓库 README 摘录，命令与配置均以原文为准。
原始 README 摘录（英文原文，节选前 3000 字符） 
<div align="center">

<img src="packages/foam-vscode/assets/icon/FOAM_ICON_256.png" width="100"/>

# Foam

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-136-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

[![Version](https://vsmarketplacebadges.dev/version/foam.foam-vscode.svg)](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode)
[![Downloads](https://vsmarketplacebadges.dev/downloads/foam.foam-vscode.svg)](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode)
[![Visual Studio Marketplace Installs](https://vsmarketplacebadges.dev/installs/foam.foam-vscode.svg)](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode)
[![Ratings](https://vsmarketplacebadges.dev/rating/foam.foam-vscode.svg)](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode)
[![Discord Chat](https://img.shields.io/discord/729975036148056075?color=748AD9&label=discord%20chat&style=flat-square)](https://discord.com/invite/HV2tn2FpEk)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/foambubble/foam)

</div>

**Foam** is a personal knowledge management and sharing system built on [Visual Studio Code](https://code.visualstudio.com/) and [GitHub](https://github.com/).

You can use **Foam** for organising your research, keeping re-discoverable notes, writing long-form content and, optionally, publishing it to the web.

**Foam** is free, open source, and extremely extensible to suit your personal workflow. You own the information you create with Foam, and you're free to share it, and collaborate on it with anyone you want.

## Features

### Graph Visualization

See how your notes are connected via a [graph](https://docs.foam.md/features/graph-view/) with the `Foam: Show Graph` command.

![Graph Visualization](./assets/screenshots/feature-show-graph.gif)

### Link Autocompletion

Foam helps you create the connections between your notes, and your placeholders as well.

![Link Autocompletion](./assets/screenshots/feature-link-autocompletion.gif)

### Sync links on file rename

Foam updates the links to renamed files, so your notes stay consistent.

![Sync links on file rename](./assets/screenshots/feature-link-sync.gif)

### Unique identifiers across directories

Foam supports files with the same name in multiple directories.
It will use the minimum identifier required, and even report and help you fix existing ambiguous wikilinks.

![Unique identifier autocompletion](./assets/screenshots/feature-unique-wikilink-completion.gif)

![Wikilink diagnostic](./assets/screenshots/feature-wikilink-diagnostics.gif)

### Link Preview and Navigation

![Link Preview and Navigation](./assets/screenshots/feature-navigation.gif)

### Go to definition, Peek References

See where a note is being referenced in your knowledge base.

![Go to Definition, Peek References](./assets/screenshots/feat
阅读完整原文

项目深度分析 AI 生成

Foam 知识库一键发布与托管 SaaS（Digital Garden 托管）

产品构想README 提到 Foam 支持将笔记发布到 Web，但原生依赖用户自行配置 GitHub Pages 或静态站点生成器。可提供专门针对 Foam 双链语法、Graph 图谱和 Backlinks 优化的一键托管发布平台。
核心功能兼容 Foam 双链（[[wikilink]]）、标签与反向链接的静态渲染；交互式在线 Graph 图谱；自定义域名与 HTTPS；密码保护/付费墙支持。
目标用户希望将技术笔记、学习记录公开为个人博客或数字花园，但不愿折腾前端构建与部署的开发者及写作者。
难度/周期中等（需处理 Markdown 解析与静态站点托管架构） · 4-8 周完成 MVP · 成本：低（主要为对象存储、CDN 流量及基础云服务费用）
收费模式按月/按年订阅制（参考同类产品如 Obsidian Publish 模式，推测）
竞争风险存在免费替代方案（如 GitHub Pages + 开源模板），需在美观度、图谱交互和零配置体验上拉开差距；需注意项目 License 为 NOASSERTION 的潜在合规问题。
依据 AI推测

基于 Foam 的 AI 知识助手（VS Code 扩展）

产品构想利用 Foam 已构建的本地 Markdown 笔记库与双链结构，开发配套的 VS Code 插件，提供基于本地知识库的语义搜索、AI 自动推荐双链及内容问答。
核心功能本地笔记向量化索引；写作时自动推荐相关历史笔记生成 [[wikilink]]；基于选定笔记或标签的 AI 问答与摘要生成。
目标用户拥有大量本地 Markdown 笔记、面临检索困难或希望提升笔记整理效率的 Foam/VS Code 重度用户。
难度/周期中等（TypeScript 开发，需对接 Embedding 与 LLM API） · 3-6 周 · 成本：低（纯插件形态，若采用用户自带 API Key 模式则无算力成本）
收费模式插件内购解锁高级功能（一次性买断或订阅制），或提供托管式云端索引服务。
竞争风险VS Code 生态中已有较多通用 AI 编程/写作助手（如 Copilot 等），需突出对 PKM 双链结构的深度理解。
依据 尚需验证的假设

垂直领域 Foam 知识库模板与工作流套件

产品构想针对特定人群（如学术科研、技术面试准备、独立开发者产品管理）打包定制化的 Foam 模板库、配置方案及自动化脚本，降低新用户的冷启动成本。
核心功能预设目录结构与 Daily Note/领域模板；配套的标签体系规范；常用 Git 同步与导出脚本；详细视频/图文配置指南。
目标用户刚接触 Foam 或 Zettelkasten 笔记法，希望快速建立标准化知识管理体系的初学者与专业人士。
难度/周期低（无需复杂编码，重在领域知识与工作流设计） · 2-4 周 · 成本：极低（主要为时间与内容制作成本）
收费模式一次性买断制（通过 Gumroad、面包多等平台销售数字产品）
竞争风险客单价通常较低，且数字模板容易被传播盗版，需结合社群或持续更新服务提升附加值。
依据 AI推测
AI 基于仓库公开数据分析生成，含推测成分，不构成收益承诺。
报告会保存到 个人中心

竞品与相似项目 GitHub Search 真实检索

相似项目数据正在完善中，暂不展示（避免误导）

项目优势与风险

技术成熟度创建于 2020-06-19，近 30 天仍在推送，发布过 100 个 Release
社区活跃Star 17,479 / Fork 791 / Issue 25（数据支持，可自行核实）
许可证NOASSERTION
主要风险上游项目方向可能变化；同赛道竞争者较多（见竞品表）；热度与需求不完全等价

安装与使用

此项目未提供 Docker 镜像，安装步骤以原仓库 README 为准（涉及依赖安装与环境配置，对新手门槛较高）。