Borrowing it
Nothing to install: this file belongs to songofhawk/doco. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.
curl -O https://raw.githubusercontent.com/songofhawk/doco/main/AGENTS.mdgit clone --depth 1 https://github.com/songofhawk/docoWrote this? Show the measurements
A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.
[](https://agentmods.dev/instructions/songofhawk/doco/agents-md)<a href="https://agentmods.dev/instructions/songofhawk/doco/agents-md"><img src="https://agentmods.dev/badge/instructions/songofhawk/doco/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.
<a href="https://agentmods.dev/instructions/songofhawk/doco/agents-md"><img src="https://agentmods.dev/badge/instructions/songofhawk/doco/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>What it costs to keep this loaded
Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.02565 | $0.02565 |
| Opus 5.5 | $0.01026 | $0.01026 |
| Sonnet 5.5 | $0.00513 | $0.00513 |
| Haiku 4.5 | $0.00257 | $0.00257 |
Grade A, and why
doco AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 1mo ago.
A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.
Nothing flagged
None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.
How it starts
The opening of the file, as written. The whole thing — 164 lines — stays where its author put it; the contents beside it link to each section on GitHub.
Doco Editor — 项目说明
基于 Tiptap (ProseMirror) + React + Vite 的富文本协同编辑器,支持多端实时同步(Yjs CRDT),具备知识库管理能力。
永远输出中文。
技术栈
| 层 | 技术 |
|---|---|
| 前端框架 | React 18 + Vite + TypeScript |
| 路由 | react-router-dom v7 |
| CSS | Tailwind CSS v4 |
| 编辑器 | Tiptap v3(基于 ProseMirror) |
| UI 组件 | Radix UI (Popover)、Lucide React (图标)、Tippy.js (弹层) |
| 协同算法 | Yjs (CRDT) + Hocuspocus(@hocuspocus/provider / @hocuspocus/server) |
| 图表 | Mermaid、PlantUML (plantuml-encoder) |
| 导出/导入 | 服务端 Markdown 导出(prosemirror-markdown)、html2pdf.js、mammoth、pdfjs-dist |
| 后端 | Node.js + Express + Hocuspocus |
| 数据库 | better-sqlite3(SQLite,WAL 模式) |
后端曾有 Python (FastAPI + ypy-websocket) 与 Cloudflare Worker 两版实现,均因同步协议缺陷于 2026-07 移除, 决策依据见 docs/重构方案-协同同步与Markdown导出.md。
目录结构
doco/
├── src/
│ ├── main.tsx # 应用入口
│ ├── App.tsx # 根组件,路由管理(/ 首页、/app 工作区、/doc/:id 文档,
│ │ # /app/doc/:id 兼容重定向),工作区外壳,导入/导出
│ ├── components/
│ │ ├── HomePage.tsx # 落地首页(奢侈品宣传页风格,配套 HomePage.css):
│ │ │ # Hero/宣言/特性/图表与代码/协同/导入导出/数据 分区;登录为点击弹出的模态框
│ │ │ # (Portal + Esc/遮罩关闭,邮箱验证码 / Google);已登录用户
│ │ │ # 可自由浏览(入口变为「进入工作区」),仅被 /app 拦截回跳时
│ │ │ # 登录成功后续走来源页;
│ │ │ # 动效:IntersectionObserver + [data-reveal] 滚动浮现,
│ │ │ # [data-parallax] rAF 视差(文字/图/背景幽灵大字错位漂移)
│ │ └── Sidebar.tsx # 知识库侧边栏(文档树管理)
│ └── editor/ # 编辑器模块(与 App 同仓同构建,无独立编译步骤)
│ ├── DocoEditor.tsx # 编辑器主组件(Yjs/Hocuspocus 初始化、扩展注册)
│ ├── types.ts # 对外 Props/Ref 类型
│ └── components/ # 各扩展与 UI(BubbleMenu、BlockHandle、MermaidBlock、
│ # CalloutBlock、SlashCommand、CollapseExtension 等)
├── backend/
│ ├── server.js # 入口:Express + Hocuspocus + 导出路由 + 优雅退出
│ ├── database.js # better-sqlite3 初始化与建表
│ ├── api.js # 知识库/文件夹/文档 REST 路由
│ ├── markdown.js # YDoc → ProseMirror JSON → Markdown(服务端导出)
│ ├── migrate.js # 旧版 ydoc_updates → ydoc_state 一次性迁移
│ └── schema.sql # 表结构参考
└── src/index.css # 全局样式(ProseMirror、折叠块等)
What this file has done since we first saw it
Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.
- 1mo ago First seen · 164 lines · 2,565 tokens per session scan A eb30445a8800
doco AGENTS.md is an instructions file published in the GitHub repository songofhawk/doco (11 stars, last pushed 1mo ago), licensed MIT. It adds 2,565 tokens to every session, about $0.0103 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.
Other instructions, from other repositories
vscode buildNext.instructions.md
Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).
next.js AGENTS.md
AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.
vscode oss-third-party-notices.instructions.md
Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).
langchain AGENTS.md
AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.
vscode copilot-instructions.md
Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).
deepseek-harness AGENTS.md
AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.