Saucebox Registry
← Browse

@davidvkimball/obsidian-ref-3

A

Technical references, manifest rules, file formats, and UX guidelines for Obsidian. Load when checking API details, manifest requirements, or UI/UX standards.

skillclaude

Install

agr install @davidvkimball/obsidian-ref-3 --target claude

Writes 1 file into .claude/skills/, pinned to git-12ea9988.

  • .claude/skills/obsidian-ref-3/SKILL.md

Document

name: obsidian-ref description: Technical references, manifest rules, file formats, and UX guidelines for Obsidian. Load when checking API details, manifest requirements, or UI/UX standards.

Obsidian Reference Skill

This skill provides comprehensive technical references and standards for the Obsidian ecosystem.

Purpose

To provide a central source of truth for API usage, file formats, and design standards.

Scope

This skill covers:

  • manifest.json requirements and validation
  • Obsidian API details and documentation
  • Obsidian-specific file formats (Markdown, Properties, Canvas)
  • UI text conventions and UX patterns
  • Mobile and platform compatibility

Core Rules

  • API Authority: The obsidian.d.ts file in the reference materials is the authoritative source for API details.
  • Terminology Consistency: Follow the "properties" and "Markdown" naming conventions strictly.
  • Mobile First: Consider mobile compatibility for all UI and file-handling features.

Bundled Resources

  • references/manifest.md: Detailed rules for manifest.json.
  • references/obsidian-file-formats.md: Specifications for Markdown, Properties, and Canvas.
  • references/ux-copy.md: UI text conventions and UX best practices.
  • references/references.md: External links and primary source locations.
  • references/mobile.md: Considerations for mobile compatibility.
  • references/performance.md: Best practices for performance.

Trustgrade A

  • passBody integrity

    Whether the stored document is plausibly the kind of file the artifact declares, rather than something fetched by mistake.

  • passType matchnot applicable to this artifact type

    Whether the artifact is really the kind of thing its metadata claims it is.

  • passFreshness

    How long since the source repository was last pushed to.

  • passPrompt injection

    Scans the artifact's own text for instructions aimed at your agent rather than at you.

  • passLicense

    Whether the source repository declares an SPDX license permissive enough to redistribute.

How the grade is calculated

Each check contributes 0 points when it passes, 1 when it warns, and 2 when it fails. The total maps to a letter:

  • Aevery check passed
  • Bone warning
  • Ctwo warnings
  • Dprompt injection or body integrity failed, or three warnings
  • Fone of those failed, and something else is wrong

These are automated hygiene checks, not a security audit, and not a dependency or vulnerability scan. A grade of A means nothing was flagged — not that the artifact is safe.

Versions

  • git-12ea99882c692026-07-31