at-ref

at-ref is a developer tool that enhances atomic documentation workflows by providing visual cues and interactive features for @/path references in markdown files. It is available both as a VS Code extension and as an npm package.

The problem

When working with atomic documentation - small, focused, interconnected documents - managing references between files becomes critical. Traditional markdown links work, but they lack:

• Visual distinction from regular text
• Quick validation of reference targets
• Easy navigation without leaving context

Features

• Visual cues for @references - highlights @/path style references in markdown files, making them instantly recognizable and easy to scan
• Clickable links - click any @/path reference to navigate directly to the target file, turning documentation into a connected knowledge graph you can traverse effortlessly
• Broken reference detection - alerts you immediately when a referenced file doesn’t exist or has been moved, helping maintain documentation integrity

Installation

Install the VS Code extension directly from the marketplace or via the Extensions panel. The npm package (@u-b/at-ref) lets you integrate at-ref functionality into your own tools and build systems:

npm install @u-b/at-ref

Use cases

• AI development workflows - pair with frameworks like all-agents for atomic documentation that AI can reliably navigate
• Knowledge management - build interconnected documentation with confidence that links stay valid
• Monorepo documentation - reference docs across packages with visual clarity

Full documentation and usage examples are available at the project homepage.