Agent skill · writing content · aiskillstore
project-to-obsidian
将代码项目转换为 Obsidian 知识库。当用户提到 obsidian、项目文档、知识库、分析项目、转换项目 时激活。 【激活后必须执行】： 1. 先完整阅读本 SKILL.md 文件 2. 理解 AI 写入规则（默认到 00_Inbox/AI/、追加式、统一 Schema） 3. 执行 STEP 0: 使用 AskUserQuestion 询问用户确认 4. 用户确认后才开始 STEP 1 项目扫描 5. 严格按 STEP 0 → 1 → 2 → 3 → 4 顺序执行 【禁止行为】： - 禁止不读 SKILL.md 就开始分析项目 - 禁止跳过 STEP 0 用户确认 - 禁止直接在 30_Resources 创建（先到 00_Inbox/AI/） - 禁止自作主张决定输出位置
Why this skill is useful
Adds a multi-step workflow for converting code projects into structured Obsidian knowledge bases, including specific document generation and linking processes.
What it needs
About 6k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
Project to Obsidian - 项目知识库生成器 将任意代码项目转换为结构化的 Obsidian 知识库，让项目知识可搜索、可链接、可扩展。 --- 🎯 核心功能 命令 功能 说明 ------ ------ ------ /p2o <项目路径> 完整转换 分析项目并生成完整 Obsidian 库 /p2o <路径> --quick 快速概览 只生成项目概览和结构 /p2o <路径> --api API 文档 专注生成 API/函数文档 /p2o <路径> --arch 架构文档 生成架构和设计文档 --- ⚡ 执行流程 --- ⚠️ AI 写入规则（必须遵守） 规则 1: 默认落地到 AI 专区 规则 2: 使用追加式写入 规则 3: 统一 Properties Schema 规则 4: 生成 Dataview 索引 --- 📋 详细执行步骤 STEP 0: 用户确认（必须先执行） 当 skill 被触发时，Claude 必须首先使用 AskUserQuestion 工具询问用户： 用户选择「取消」时，立即停止，不执行后续步骤。 用户确认后，继续显示项目信息并询问生成模式： STEP 1: 项目扫描 STEP 3: 代码分析 STEP 4: 生成 Obsidian 结构 --- 📝 文档模板 项目概览模板 (MOC) {{项目结构树}} API 文档模板 http {{方法}} {{路径}} json {{请求示例}} json {{响应示例}} 模块说明模板 {{语言}} {{函数签名}} {{语言}} {{使用示例}} mermaid graph LR {{模块}} --> {{依赖1}} {{模块}} --> {{依赖2}} --- 🔧 输出选项 选项 1: 输出到 Obsidian Vault (推荐) 选项 2: 创建本地文件夹 选项 3: 输出到项目 /docs --- 🎯 使用示例 示例 1: 完整转换 示例 2: 快速概览 示例 3: 只生成 API 文档 --- 🔗 与其他工具集成 与 obsidian-helper 集成 生成的知识库完全兼容 obsidian-helper： 与 MCP 工具集成 --- ⚙️ 配置选项 在目标 vault 创建 config/project-to-obsidian.md 自定义： --- 🚨 错误处理 情况 处理 ------ ------ 项目路径不存在 提示用户检查路径 项目太大 (>1000 文件) 建议使用 --quick 模式或指定子目录 无法识别项目类型 询问用户手动指定语言/框架 MCP 未连接 自动切换到本地文件输出 写入失败 回滚并提示错误原因 --- 📚 支持的项目类型 语言/框架 识别标志 特殊处理 ----------- ---------- ---------- Node.js package.json 提取 scripts, dependencies TypeScript tsconfig.json 提取类型定义 Python pyproject.toml, setup.py 提取 docstrings Go go.mod 提取包结构 Rust Cargo.toml 提取 crate 结构 Java pom.xml, build.gradle 提取类和接口 React/Vue/Angular 框架配置 提取组件结构 Express/FastAPI/Gin 路由文件 提取 API 端点 --- 📎 快速参考 --- Project to Obsidian v1.0.0 - 让代码知识可视化
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/project-to-obsidian