home-assistant-markdown-liquid-style

Applies Home Assistant website Markdown and Liquid style conventions when editing documentation.

9.8k|8.5k|Updated Dec 21, 2014
One-click install
npx skills add https://github.com/home-assistant/home-assistant.io --skill home-assistant-markdown-liquid-style
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: home-assistant-markdown-liquid-style
Source: https://github.com/home-assistant/home-assistant.io/tree/main/.claude/skills/home-assistant-markdown-liquid-style
Command: npx skills add https://github.com/home-assistant/home-assistant.io --skill home-assistant-markdown-liquid-style

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Contributors to the Home Assistant website must follow specific Markdown, Liquid, linking, and formatting conventions, and this Skill ensures edits comply with those rules without memorizing the full style guide.

Core Features & Use Cases

  • Style Enforcement: Applies GitHub Flavored Markdown rules, heading hierarchy, list formatting, and 80-character code block limits.
  • Liquid Templating Guidance: Provides correct syntax for My links, glossary terms, text boxes, details blocks, icons, and reusable includes.
  • Media and Link Rules: Enforces internal absolute link formats, image hosting in the repository, and lite-youtube embeds for videos.
  • Use Case: When editing an integration documentation page, use this Skill to insert a config flow include, add glossary tooltips for terms like entity, and format a caution text box correctly.

Quick Start

Review my changes to the Home Assistant integration documentation page and fix any Markdown or Liquid style violations.

Frequently Asked Questions about home-assistant-markdown-liquid-style

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

FAQPage Schema
How do I link to other Home Assistant documentation pages?

Use absolute links that ignore the source directory and the leading underscore of the first folder. For example, link to source/_integrations/date.markdown as /integrations/date/, using a trailing slash instead of file extensions like .markdown or .md.

How do I add a glossary term tooltip in Home Assistant docs?

Use the Liquid syntax {% term <term> %} with a term or alias defined in source/_data/glossary.yml. For multi-word terms, quote them, such as {% term "configuration.yaml" %}. If a term is missing, add it to the glossary file.

What is a My link in Home Assistant documentation?

A My link opens a page directly in the reader's own Home Assistant installation, helping them follow a UI path. Use syntax like {% my integrations title="**Settings** > **Devices & services**" %} to reference common settings pages.

Can I use HTML instead of Markdown in Home Assistant docs?

Markdown is preferred over HTML wherever possible. Exceptions include abbreviation tags for acronyms, the lite-youtube element for videos, and the p class='img' pattern for captioned images.

How do I embed a YouTube video in Home Assistant documentation?

Use the lite-youtube element with the videoid attribute set to the part of the YouTube URL after watch?v=. Add videoStartAt only when playback should begin at a specific time, and include a videotitle.

When should I use caution versus warning text boxes?

Use caution for actions that may cause data loss or hard-to-reverse consequences. Use warning for risks that could compromise system security or integrity, or cause physical harm. Avoid overusing text boxes overall.