Obsidian Blog Requirements

Obsidian Blog Requirements

Overview

Use this skill to validate Obsidian notes for gen-blog. It defines the required frontmatter, image handling rules, and the fail-fast behaviors the generator enforces.

Quick Workflow

1. Confirm the vault path and run npm run generate -- <vaultDir> dist.
2. If generation fails, map errors to fixes using references/troubleshooting.md.
3. Ensure every published post meets the frontmatter rules in references/frontmatter.md.

Core Rules (Summary)

• Filter rule: A note is included only when blog_publish: true. Missing blog_publish means the note is ignored.
• Required fields for published posts: blog_title, blog_date, blog_lang, blog_translation_key, blog_category, blog_excerpt.
• Translation key format: Lowercase slug or path (a-z0-9 + -), no spaces; see examples in references/frontmatter.md.
• Categories: blog_category is a non-empty list; multiple categories are allowed; first item is used as primaryCategory in output.
• About page: Use blog_translation_key: about and provide both zh and en.
• Images: Images referenced by posts can be local files anywhere in the vault, external URLs, or data URIs. The generator copies/normalizes them into dist/assets (WebP + compressed fallback) without modifying sources.

References

• references/frontmatter.md - Required fields + example frontmatter
• references/troubleshooting.md - Error messages and fixes