Centralized documentation for Obsidian API and UX best practices.

Install

mkdir -p .claude/skills/obsidian-ref && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/9691" && unzip -o skill.zip -d .claude/skills/obsidian-ref && rm skill.zip

Installs to .claude/skills/obsidian-ref

Activation

This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.

Technical references, manifest rules, file formats, and UX guidelines for Obsidian. Load when checking API details, manifest requirements, or UI/UX standards.
158 chars✓ has a “when” trigger
Beginner

Key capabilities

  • Manifest validation
  • API reference lookup
  • UI/UX standard application
  • File format specification

How it works

It provides authoritative documentation on Obsidian's API, manifest requirements, and UI conventions.

Inputs & outputs

You give it
Obsidian API or manifest question
You get back
Technical reference or standard

When to use obsidian-ref

  • Check Obsidian API usage
  • Validate plugin manifest
  • Apply Obsidian UI standards

About this skill

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.

When not to use it

  • Non-Obsidian development
  • General markdown editing

Limitations

  • Limited to Obsidian ecosystem
  • Requires adherence to API authority

How it compares

It acts as a central source of truth for Obsidian-specific development standards.

Compared to similar skills

obsidian-ref side by side with the closest alternatives in the catalog.

SkillInstallsUpdatedSafetyDifficulty
obsidian-ref (this skill)03moNo flagsBeginner
meeting-minutes416moNo flagsBeginner
internal-comms83moNo flagsBeginner
obsidian-markdown97moNo flagsBeginner

Try saying

Example prompts that trigger this skill in your AI assistant.

Search skills

Search the agent skills registry