docs-syntax-help

Name: docs-syntax-help
Availability: InStock
Author: elastic

Troubleshoot Elastic documentation syntax for MyST Markdown and custom directives.

71|10|Updated Aug 20, 2025

Search Tags:#documentation #markdown #troubleshooting #syntax #directives #myst

Ready to run

npx skills add https://github.com/elastic/elastic-docs-skills --skill docs-syntax-help

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs-syntax-help
Source: https://github.com/elastic/elastic-docs-skills/tree/main/skills/authoring/docs-syntax-help
Command: npx skills add https://github.com/elastic/elastic-docs-skills --skill docs-syntax-help

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill helps users write and troubleshoot documentation using Elastic's specific MyST Markdown syntax, ensuring consistency and correctness.

Core Features & Use Cases

Syntax Guidance: Provides correct syntax for directives, admonitions, links, code blocks, tabs, and more.
Troubleshooting: Identifies and fixes common syntax errors and build issues.
Use Case: When you encounter a build error related to a directive or are unsure how to format a specific element like a tabbed code example, use this Skill for immediate assistance.

Quick Start

Ask the docs syntax skill for the correct way to create a tabbed code example.

Frequently Asked Questions about docs-syntax-help

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

FAQPage Schema

How do I fix MyST Markdown directive formatting errors in Elastic Docs?▼

To fix MyST Markdown directive formatting errors, ensure correct directive syntax, verify admonition indentation, check code block fences, and validate applies-switches to resolve build issues.

What is the correct syntax for creating tabbed code examples in Elastic documentation?▼

The correct syntax for tabbed code examples involves using specific custom MyST Markdown directives to structure tabs, ensuring proper nesting and formatting to prevent build errors.

Why does my Elastic documentation build fail with admonition syntax issues?▼

Your Elastic documentation build fails with admonition syntax issues when MyST Markdown directives are improperly formatted, nested incorrectly, or missing required arguments within the markup.

How do I apply conditional content switches in MyST Markdown for Elastic Docs?▼

To apply conditional content switches in MyST Markdown, use the applies-switches directive syntax to toggle documentation sections based on specific deployment contexts or configurations.

Can I use standard Markdown links and code blocks in Elastic documentation?▼

Yes, you can use standard Markdown links and code blocks, but Elastic documentation requires specific MyST Markdown syntax and custom directives to ensure proper rendering and build consistency.

How do I troubleshoot MyST Markdown build errors related to custom directives?▼

To troubleshoot MyST Markdown build errors related to custom directives, validate directive syntax, check for missing arguments, review admonition formatting, and verify proper code block nesting.