obsidian-doc-check

Validate Obsidian markdown documents against project-specific conventions.

1|Updated Feb 11, 2026
One-click install
npx skills add https://github.com/tsuji-tomonori/diopside-v3 --skill obsidian-doc-check
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obsidian-doc-check
Source: https://github.com/tsuji-tomonori/diopside-v3/tree/main/.opencode/skills/obsidian-doc-check
Command: npx skills add https://github.com/tsuji-tomonori/diopside-v3 --skill obsidian-doc-check

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires PyYAML, and includes scripts (resource) components.

What problem does it solve?

This Skill automates the validation of Obsidian documents within the diopside project, ensuring adherence to specific formatting, linking, and organizational conventions.

Core Features & Use Cases

  • Frontmatter Validation: Checks for mandatory keys and correct formatting in YAML frontmatter.
  • Link Integrity: Verifies that internal document links ([[...]]) are valid and resolve correctly.
  • Naming Conventions: Enforces consistency between filenames and document IDs.
  • Use Case: Before committing changes to the diopside documentation, run this Skill to automatically catch any broken links, missing metadata, or convention violations, preventing integration issues.

Quick Start

Run the obsidian-doc-check skill to validate all markdown documents in the docs directory.

Frequently Asked Questions about obsidian-doc-check

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I validate Obsidian markdown frontmatter and internal links automatically?

Obsidian markdown frontmatter and internal links are validated using automated Python scripts that check for mandatory YAML keys, correct formatting, and ensure [[...]] cross-references resolve correctly to maintain documentation integrity.

What is the best way to enforce file naming conventions in Obsidian documentation?

File naming conventions in Obsidian documentation are enforced by automated validation scripts that check consistency between filenames and document IDs, ensuring strict adherence to project-specific organizational standards before integration.

Do I need PyYAML to check Obsidian document structure and cross-references?

Yes, PyYAML is required as a dependency to parse and validate the YAML frontmatter within Obsidian markdown documents, enabling the automated checking of document structure and cross-references.

How do I catch broken links and missing metadata in markdown before committing changes?

Broken links and missing metadata are caught by running an automated validation check across markdown documents in the docs directory, verifying link integrity and frontmatter compliance before committing changes to prevent integration issues.

Can I check if internal document links in Obsidian resolve correctly without manual review?

Internal document links in Obsidian can be checked automatically without manual review by running validation scripts that verify [[...]] syntax resolves to valid targets, ensuring document discoverability and cross-reference integrity.

Why does my markdown validation fail when document IDs do not match filenames?

Markdown validation fails when document IDs and filenames mismatch because the convention rules enforce strict naming consistency, requiring filenames to exactly match their corresponding document IDs to pass automated checks.