blog-format

Validate blog post frontmatter and relative image paths.

1|Updated Dec 29, 2024

Search Tags:#markdown #blogging #validation #technical writing #content formatting

Ready to run

npx skills add https://github.com/littlewwwhite/littlewwwhite.github.io --skill blog-format-littlewwwhite

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: blog-format
Source: https://github.com/littlewwwhite/littlewwwhite.github.io/tree/main/.claude/skills/blog-format
Command: npx skills add https://github.com/littlewwwhite/littlewwwhite.github.io --skill blog-format-littlewwwhite

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures your blog posts adhere to a consistent structure and use correct image path conventions, preventing common errors before publishing.

Core Features & Use Cases

Frontmatter Validation: Checks for required fields like title, date, categories, and tags.
Image Path Verification: Ensures images use relative Page Bundle format and flags absolute paths or incorrect subfolders.
Minimal Fixes: Attempts minor corrections while prioritizing flagging issues for review.
Use Case: Before committing your latest article, run this Skill to automatically catch any missing frontmatter or incorrectly referenced images, saving you from broken links or incomplete posts.

Quick Start

Validate the structure and image paths for the blog post located at /path/to/your/post.md.

Frequently Asked Questions about blog-format

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

FAQPage Schema

How do I validate markdown blog post frontmatter before publishing?▼

To validate markdown blog post frontmatter, this Skill checks for required fields like title, date, categories, and tags, flagging any missing metadata to ensure your technical writing adheres to structural requirements before publishing.

How do I check relative image paths in markdown Page Bundles?▼

Checking relative image paths in markdown Page Bundles involves verifying that images use relative linking conventions and flagging absolute paths or incorrect subfolders, which this Skill does automatically to prevent broken image links.

Can I automatically fix incorrect image linking conventions in technical writing?▼

You can apply minimal automated fixes for incorrect image linking conventions, though this Skill prioritizes flagging structural issues for manual review to maintain strict consistency in your technical writing.

What are common frontmatter requirements for markdown blogging?▼

Common frontmatter requirements for markdown blogging include mandatory metadata fields such as title, date, categories, and tags, which are verified during validation to prevent incomplete posts from being committed.

Why does blog post validation flag absolute image paths?▼

Blog post validation flags absolute image paths because they break relative linking conventions; this Skill ensures images use Page Bundle format and flags incorrect subfolders to maintain consistent technical documentation.