agentleFS
Sign inStart free
davidvkimballdavidvkimball/obsidian-dev-skills/obsidian-ref/SKILL.md

obsidian-ref

Skill51 starsChanged 10 months agoMITView on GitHub

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

The file

We split this skill into the rules it gives an agent

2 rules. About 0 are common, 2 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Terminology Consistency: Follow the "properties" and "Markdown" naming conventions strictly.

    line 26
  2. Distinctive:

    Mobile First: Consider mobile compatibility for all UI and file-handling features.

    line 27

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free