Skip to content
/ Timber Public
forked from Shopify/Timber

The ultimate Shopify theme framework, built by Shopify.

License

Notifications You must be signed in to change notification settings

klaser/Timber

 
 

Repository files navigation

Shopify Timber Circle CI

Timber is a theme framework for Shopify that helps you get your store up and running quickly. It provides all required theme templates, a starter set of liquid tags, and some basic styles and modules for you to extend on.

Styling and customization is left up to you. Some base styles and helpers are included, but there is no need to remove any code before you start. Simply download and get designing.

Designing a store for a client? Earn 20% revenue through our Partner program.

Ways to Get Started

  • Download the latest release
  • Clone the repo git clone https://github.com/Shopify/Timber.git
  • Or install with Bower bower install timber

Documentation

Visit the Timber's Documentation page to find out more about the templates, liquid tags, CSS framework, and JavaScript modules included.

Timber's documentation is hosted on GitHub Pages. View the raw files in the gh-pages branch. Please report any discrepancies, bugs, or requests in issues.

Demo Stores

  • Demo Store: A store setup with some products, blog posts, and customer accounts
  • Empty Store: A fresh store, just what you should expect when you install on your new store

For a set of demo products to use during development, download this CSV file and import it on our products page.

Basic structure

├── assets
│   └── Javascript, CSS, and theme images
├── layout
│   ├── theme.liquid
│   └── optional alternate layouts
├── snippets
│   └── custom code snippets
├── spec
│   └── tests and helpers
├── templates
│   ├── 404.liquid
│   ├── article.liquid
│   ├── blog.liquid
│   ├── cart.liquid
│   ├── collection.liquid
│   ├── collection.list.liquid
│   ├── index.liquid
│   ├── list-collections.liquid
│   ├── page.contact.liquid
│   ├── page.liquid
│   ├── product.liquid
│   ├── search.liquid
│   └── customers
│         └── required templates if customer accounts are enabled
├── config.yml
│   └── if using the theme gem (see link under Additional Resources)

i18n testing

Tests make sure there are no missing or extra i18n strings or invalid html in your locale liquid files.

All PRs must pass the tests before being merged. Check the test status when you open a new PR on GitHub, or locally with the following.

  • bundle install to install all the dependecies
  • rspec spec to run all the tests

Support

Get involved with Timber or follow along with updates and news.

Additional resources

License

Timber is released under the MIT License.

About

The ultimate Shopify theme framework, built by Shopify.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Liquid 96.5%
  • Ruby 2.5%
  • HTML 1.0%