Labyricorn/liquid
1
0
Fork 0
mirror of https://github.com/Shopify/liquid.git synced 2026-09-29 07:05:12 -07:00
Code Issues Packages Projects Releases Wiki Activity

added Helpjuice

Buda9
2014-09-16 06:20:12 -07:00
parent 62fd020103
commit 350b4b9344
1 changed files with 107 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Home.md
+107 -106
@@ -1,107 +1,108 @@
Liquid is a template engine which was crafted for very specific requirements Liquid is a template engine which was crafted for very specific requirements
* It has to have simple markup and beautiful results. Template engines which * It has to have simple markup and beautiful results. Template engines which
don't produce good looking results are no fun to use. don't produce good looking results are no fun to use.
* It needs to be non-evaling and secure. Liquid templates are made so that users * It needs to be non-evaling and secure. Liquid templates are made so that users
can edit them. You don't want your server running code that your users can edit them. You don't want your server running code that your users
wrote. wrote.
* It has to be stateless. The compile and render steps have to be separate, so * It has to be stateless. The compile and render steps have to be separate, so
that the expensive parsing and compiling can be done once; later on, you can that the expensive parsing and compiling can be done once; later on, you can
just render it by passing in a hash with local variables and objects. just render it by passing in a hash with local variables and objects.
* It needs to be able to style emails as well as HTML. * It needs to be able to style emails as well as HTML.
## Stuff to read, watch, etc. ## Stuff to read, watch, etc.
* [Class reference](http://rubydoc.info/gems/liquid) * [Class reference](http://rubydoc.info/gems/liquid)
* [[Liquid for Programmers]] * [[Liquid for Programmers]]
* [[Liquid for Designers]] * [[Liquid for Designers]]
* [Liquid screencast](http://railscasts.com/episodes/118-liquid) * [Liquid screencast](http://railscasts.com/episodes/118-liquid)
* [[Ports of Liquid to other environments]] * [[Ports of Liquid to other environments]]
## Who uses Liquid? ## Who uses Liquid?
* [Shopify](http://www.shopify.com) * [Shopify](http://www.shopify.com)
* [eLocal](http://www.elocal.com) * [eLocal](http://www.elocal.com)
* [Mephisto](http://mephistoblog.com/) * [Mephisto](http://mephistoblog.com/)
* [Harmony](http://get.harmonyapp.com) * [Harmony](http://get.harmonyapp.com)
* [Chameleon](http://chameleon.wikidot.com/) * [Chameleon](http://chameleon.wikidot.com/)
* [Cashboard](http://www.getcashboard.com) * [Cashboard](http://www.getcashboard.com)
* [Adobe Business Catalyst](http://businesscatalyst.com/) * [Adobe Business Catalyst](http://businesscatalyst.com/)
* [Edicy](http://www.edicy.com) * [Edicy](http://www.edicy.com)
* [Workory](http://www.workory.com) * [Workory](http://www.workory.com)
* [Zendesk](http://www.zendesk.com) * [Zendesk](http://www.zendesk.com)
* [SandwichBoard](http://www.sandwichboard.com/) * [SandwichBoard](http://www.sandwichboard.com/)
* [YikeSite (CMS)](http://api.yikesite.com/) * [YikeSite (CMS)](http://api.yikesite.com/)
* [Simplicant (Applicant Tracking System)](http://www.simplicant.com/) * [Simplicant (Applicant Tracking System)](http://www.simplicant.com/)
* [3scale (API Management System)](http://www.3scale.net/) * [3scale (API Management System)](http://www.3scale.net/)
* [Chaptercore](http://www.chaptercore.com) * [Chaptercore](http://www.chaptercore.com)
* [ScreenSteps Live](http://bluemangolearning.com/screenstepslive) * [ScreenSteps Live](http://bluemangolearning.com/screenstepslive)
* [PokerAffiliateSolutions](http://www.pokeraffiliatesolutions.com/) * [PokerAffiliateSolutions](http://www.pokeraffiliatesolutions.com/)
* [Desk.com](http://www.desk.com) * [Desk.com](http://www.desk.com)
* [Ronin](http://www.roninapp.com) * [Ronin](http://www.roninapp.com)
* [CrowdVine](http://www.crowdvine.com) * [CrowdVine](http://www.crowdvine.com)
* [AboutOne](http://www.aboutone.com) * [AboutOne](http://www.aboutone.com)
* [RightScale](http://support.rightscale.com/15-References/Liquid_Markup_with_RightScale_Widgets) * [RightScale](http://support.rightscale.com/15-References/Liquid_Markup_with_RightScale_Widgets)
* [Menumill](http://www.menumill.com) * [Menumill](http://www.menumill.com)
* [Moxie Software](http://www.moxiesoft.com/) * [Moxie Software](http://www.moxiesoft.com/)
* [Rusic](http://rusic.com/) * [Rusic](http://rusic.com/)
* [Development Seed](http://developmentseed.org/blog/2011/09/09/jekyll-github-pages/) * [Development Seed](http://developmentseed.org/blog/2011/09/09/jekyll-github-pages/)
* [peerTransfer](http://peertransfer.com) * [peerTransfer](http://peertransfer.com)
* [NationBuilder](http://nationbuilder.com/) * [NationBuilder](http://nationbuilder.com/)
* [Vendder](http://vendder.com/) * [Vendder](http://vendder.com/)
* [tradelr](http://www.tradelr.com) * [tradelr](http://www.tradelr.com)
* [Avenue](http://www.prontoavenue.biz) * [Avenue](http://www.prontoavenue.biz)
* [Device Magic](http://www.devicemagic.com) * [Device Magic](http://www.devicemagic.com)
* [Spiceworks](http://www.spiceworks.com) * [Spiceworks](http://www.spiceworks.com)
* [PufferPages (CMS)](https://github.com/puffer/puffer_pages/) * [PufferPages (CMS)](https://github.com/puffer/puffer_pages/)
* [Displet](http://displet.com) * [Displet](http://displet.com)
* [Paspartout](http://paspartout.com) * [Paspartout](http://paspartout.com)
* [TrackGrid](http://www.trackgrid.com) * [TrackGrid](http://www.trackgrid.com)
* [Jekyll](http://jekyllrb.com/) * [Jekyll](http://jekyllrb.com/)
* [Octopress](http://octopress.org/) * [Octopress](http://octopress.org/)
* [Vnda](http://www.vnda.com.br/) * [Vnda](http://www.vnda.com.br/)
* [Xeemio](http://www.xeemio.com/) * [Xeemio](http://www.xeemio.com/)
* [LeadFormance](http://www.leadformance.com/) * [LeadFormance](http://www.leadformance.com/)
* [23 Video](http://www.23video.com/) * [23 Video](http://www.23video.com/)
* [CrystalCommerce](http://www.crystalcommerce.com/) * [CrystalCommerce](http://www.crystalcommerce.com/)
* [Rackspace](http://www.rackspace.com/) * [Rackspace](http://www.rackspace.com/)
* [Savory](http://www.savory.io/) * [Savory](http://www.savory.io/)
* [Talent Technology](http://www.talenttech.com) * [Talent Technology](http://www.talenttech.com)
* [WebKite](http://webkite.com/) * [WebKite](http://webkite.com/)
* [Adam Ralph](http://adamralph.com/) * [Adam Ralph](http://adamralph.com/)
* [Quaderno](http://getquaderno.com/) * [Quaderno](http://getquaderno.com/)
* [LocomotiveCMS](http://locomotivecms.com/) * [LocomotiveCMS](http://locomotivecms.com/)
* [Customer.io](http://customer.io) * [Customer.io](http://customer.io)
* [Mixture.io](http://mixture.io) * [Mixture.io](http://mixture.io)
* [MakePlans](http://makeplans.net) * [MakePlans](http://makeplans.net)
* [Planning Center Services](http://get.planningcenteronline.com) * [Planning Center Services](http://get.planningcenteronline.com)
* [Planning Center Resources](http://get.planningcenteronline.com/resources) * [Planning Center Resources](http://get.planningcenteronline.com/resources)
* [RoQua](http://www.roqua.nl) * [RoQua](http://www.roqua.nl)
* [Evrone](http://www.evrone.com) * [Evrone](http://www.evrone.com)
* [Liquid.as](https://github.com/prevailhs/liquid.as) * [Liquid.as](https://github.com/prevailhs/liquid.as)
* [Open Liquid](https://github.com/23/openliquid) * [Open Liquid](https://github.com/23/openliquid)
* [500px](http://portfolios.500px.com) * [500px](http://portfolios.500px.com)
* [VTEX](http://www.vtex.com.br/) * [VTEX](http://www.vtex.com.br/)
* [Xorcode](http://www.xorcode.com/) * [Xorcode](http://www.xorcode.com/)
* [MobiCheckin (registration forms)](http://www.mobicheckin.com) * [MobiCheckin (registration forms)](http://www.mobicheckin.com)
* [Educative-Games.org](http://educative-games.org) * [Educative-Games.org](http://educative-games.org)
* [GiftFold](http://giftfold.com) * [GiftFold](http://giftfold.com)
* [Reamaze](http://www.reamaze.com) * [Reamaze](http://www.reamaze.com)
* [Sitebox.io](http://www.sitebox.io) * [Sitebox.io](http://www.sitebox.io)
* [Stunning](https://bestunning.net) * [Stunning](https://bestunning.net)
* [Vero (Email Marketing Software)](https://www.getvero.com) * [Vero (Email Marketing Software)](https://www.getvero.com)
* [GoDaddy](https://www.godaddy.com) * [GoDaddy](https://www.godaddy.com)
* [SendOwl](http://www.sendowl.com) * [SendOwl](http://www.sendowl.com)
* [FOX21.at](http://blog.fox21.at) * [FOX21.at](http://blog.fox21.at)
* [Bright Sites](http://www.brightsites.com) * [Bright Sites](http://www.brightsites.com)
* [Mode Analytics] (http://www.modeanalytics.com) * [Mode Analytics] (http://www.modeanalytics.com)
* ...Add yours :) * [Helpjuice](https://www.helpjuice.com)
* ...Add yours :)
## Why should I use Liquid?
## Why should I use Liquid?
* You want to allow your users to edit the appearance of your application, but
don't want them to run insecure code on your server. * You want to allow your users to edit the appearance of your application, but
* You want to render templates directly from the database. don't want them to run insecure code on your server.
* You like Smarty-style template engines. * You want to render templates directly from the database.
* You need a template engine which does HTML just as well as emails. * You like Smarty-style template engines.
* You need a template engine which does HTML just as well as emails.
* You don't like the markup language of your current template engine. * You don't like the markup language of your current template engine.