Docs
  • Release notes
  • Troubleshoot
  • Reference
  1. Docs /
  2. docs-builder /
  3. Syntax guide

Syntax quick reference

Note

👋 This page has moved to the main Elastic docs: Syntax quick reference

Previous
Syntax guide
Next
How directives work
  • View as Markdown
  • Report a docs issue
  • Edit this page
  • Learn how to contribute
Get started free
  • 14-day free trial
  • All features included
  • No setup required
  • Elastic fundamentals
  • Solutions and use cases
  • Manage data
  • Explore and analyze
  • Deploy and manage
  • Manage your Cloud account
  • Troubleshoot
  • Release notes
  • Reference
  • Extend and contribute
  • Contribute to the docs
  • docs-builder
  • Getting started
    • Installation
    • Serve & preview
    • Writing content
    • Pages & links
    • Publish
  • Syntax guide
    • Quick reference
    • How directives work
    • Headings
    • Admonitions
    • Agent skill
    • Applies to
    • Applies switch
    • Automated settings reference
    • Buttons
    • Card group
    • Changelog
    • Code
    • Comments
    • Contributors
    • CSV files
    • Dropdowns
    • Definition lists
    • Explore
    • File inclusion
    • Footnotes
    • Frontmatter
    • Get started
    • Hero
    • Hub pages
    • Icons
    • Images
    • Videos
    • Keyboard markup
    • Link card
    • Math
    • Vector sizing calculator
    • Mermaid diagrams
    • Lists
    • Task Lists
    • Line breaks
    • Storybook
    • Links
    • List sub-pages
    • Page cards
    • Related learning
    • Stepper
    • Substitutions
    • Version Variables
    • Sundries
    • Tables
    • Tabs
    • Title
    • What's new
  • Examples
    • docs-builder documentation hub
  • Documentation Builds
    • Distributed
    • Cross-links
    • Isolated
      • Configuration
      • Navigation
      • URLs
      • CTA
      • Extensions
      • Move files and folders
    • Assembler
      • Configuration
      • Navigation
      • URLs
      • Environments
      • Add a new repo to the docs
      • Infrastructure
    • Codex
      • Configuration
      • Navigation
      • URLs
      • Infrastructure
    • Catalog Configuration
      • products.yml
      • related-learning.yml
      • versions.yml
      • search.yml
      • legacy-url-mappings.yml
    • Redirects
  • Structured Data
    • MCP server
    • REST API
    • OpenAPI
      • API Explorer
      • Supplemental content
    • CLI Schema
      • Supplemental content
    • Exporters
      • Elasticsearch
      • LLM Markdown
      • OKF
      • Plain Text
    • Release notes
      • Create release notes from changelogs
        • Configure changelogs
          • Configuration reference
        • Create changelogs
        • Bundle changelogs
        • Publish changelogs
      • Release Notes Explorer
  • Elastic Integrations
    • GitHub
    • Elastic CLI
  • CLI Reference
    • assemble cmd
    • build cmd
    • diff cmd
    • format cmd
    • index cmd
    • mv cmd
    • serve cmd
    • assembler ns
      • ai-enrich cmd
      • build cmd
      • clone cmd
      • index cmd
      • serve cmd
      • sitemap cmd
      • bloom-filter ns
        • create cmd
        • lookup cmd
      • config ns
        • init cmd
      • content-source ns
        • match cmd
        • validate cmd
      • deploy ns
        • apply cmd
        • plan cmd
        • update-redirects cmd
      • navigation ns
        • validate cmd
        • validate-link-reference cmd
    • changelog ns
      • add cmd
      • backfill cmd
      • bundle cmd
      • bundle-amend cmd
      • evaluate-artifact cmd
      • evaluate-pr cmd
      • gh-release cmd
      • github-comment cmd
      • github-decision cmd
      • init cmd
      • note cmd
      • prepare-artifact cmd
      • remove cmd
      • render cmd
      • scrubber-allowlist cmd
      • upload cmd
      • validate cmd
      • validate-labels cmd
      • validate-onboarding cmd
    • codex ns
      • build cmd
      • clone cmd
      • index cmd
      • serve cmd
      • update-redirects cmd
      • sync ns
        • apply cmd
        • plan cmd
    • inbound-links ns
      • validate cmd
      • validate-all cmd
      • validate-link-reference cmd
  • Development Notes
    • Navigation system
    • Elasticsearch Ingest
    • essc — sourcing CLI
    • Changelog bundle registry
    • Link validation
Elastic logo
  • Trademarks
  • Terms of Use
  • Privacy
  • Sitemap

© 2026 Elasticsearch B.V. All Rights Reserved.

This content is available in different formats for convenience only. All original licensing terms apply.

Elasticsearch is a trademark of Elasticsearch B.V., registered in the U.S. and in other countries. Apache, Apache Lucene, Apache Hadoop, Hadoop, HDFS and the yellow elephant logo are trademarks of the Apache Software Foundation in the United States and/or other countries.