Skip to content

About

A reference for liquid documentation

Resources

Code of conduct

Security policy

Stars

109 stars

Watchers

141 watching

Forks

Latest commit

 

History

1,023 Commits

Folders and files

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 data/, you have access to:

  • filters — All available Liquid filters
  • tags — All Liquid tags
  • objects — All Liquid objects
  • latest.json — Identifies the version of Liquid data used by CLI, theme-tools, and other dependent projects. See Updating revision number for details.

Check ai/liquid.mdc for examples.

Updating revision number

Run the GitHub Action to update the Liquid docs used by all dependent projects.

🚨 IF YOU DONT RUN THIS ACTION, DEPENDENT PROJECTS WILL USE LIQUID DOCS IDENTIFIED BY THE REVISION ID IN data/latest.json.

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

Code of conduct

Security policy

Stars

109 stars

Watchers

141 watching

Forks

Releases

Packages

Used by

Contributors

Languages