Skip to content

Shopify/theme-liquid-docs

Repository files navigation

Theme Liquid Docs

Auto-generated documentation for Liquid schemas, drops, tags, and filters. Documentation stays fresh—whenever you update the schema, docs regenerate automatically.

Quick Start

git clone https://github.com/Shopify/theme-liquid-docs
cd theme-liquid-docs
yarn install

What's Inside

  • data/ — JSON files with Liquid drops, tags, and filters for themes
  • schemas/ — JSON Schema definitions for Liquid theme artifacts
  • ai/ — Context files that power AI-generated Liquid rules
  • tests/ — Test suite ensuring documentation accuracy
  • scripts/ — Automation scripts for docs generation

Available data

In .liquid templates, you have access to:

  • filters — All available Liquid filters
  • tags — All Liquid tags
  • objects — All Liquid objects

Check ai/sources/_liquid-rules.liquid for examples.

Contributing

Help us make these docs better:

  1. Fork this repository
  2. Create your feature branch (git checkout -b improve-liquid-docs)
  3. Commit your changes (git commit -m 'Add array filter examples')
  4. Push and create a Pull Request

License

MIT License. See LICENSE for details.

About

A reference for liquid documentation

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 24