mirror of
https://github.com/moparisthebest/android.moparisthebest.org
synced 2025-02-28 08:21:52 -05:00
Added documentation for puts plugin
This commit is contained in:
parent
829b9737d2
commit
f2e96ac168
@ -73,4 +73,15 @@ Import files on your file system into any blog post or page. For example, to emb
|
||||
|
||||
[Examples & documentation »](/docs/plugins/render-partial/)
|
||||
|
||||
## Puts
|
||||
Puts is a Liquid block which outputs its contents to your terminal with Ruby's `puts` command. This really handy when you're working on a Liquid tag or a Jekyll plugin and you want to to be able to peek behind the curtain at what Liquid sees.
|
||||
|
||||
{% raw %}
|
||||
{% for post in site.posts reverse %}
|
||||
{% puts %}{{ post.title }}{% endputs %}
|
||||
{% endfor %}
|
||||
{% endraw %}
|
||||
|
||||
[Examples & documentation »](/docs/plugins/puts/)
|
||||
|
||||
Also see the [Octopress Plugin index](/docs/plugins) for the full list of Octopress plugins.
|
||||
|
53
source/docs/plugins/puts/index.markdown
Normal file
53
source/docs/plugins/puts/index.markdown
Normal file
@ -0,0 +1,53 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Puts - log from Liquid to the terminal"
|
||||
date: 2011-07-22 09:14
|
||||
sidebar: false
|
||||
footer: false
|
||||
---
|
||||
|
||||
Puts is a Liquid block which outputs its contents to your terminal with Ruby's `puts` command. This really handy when you're working on a Liquid tag or a Jekyll plugin and you want to to be able to peek behind the curtain at what Liquid sees.
|
||||
|
||||
#### Syntax
|
||||
|
||||
{% puts %}Optional Text: {{ some_liquid_variable }}{% endputs %}
|
||||
|
||||
This just outputs the contents of the block to the terminal. Note: Markdown, Textile and other converters run after liquid, so you'll see raw templating markup, not processed html.
|
||||
|
||||
#### Example 1
|
||||
|
||||
{% for post in site.posts %}
|
||||
{% puts %}Title: {{ post.title }}{% endputs %}
|
||||
{% endfor %}
|
||||
|
||||
#### Output:
|
||||
|
||||
```
|
||||
{% puts %} Title: Hello World, I just switched to Octopress
|
||||
{% puts %} Title: Zombie Ninjas Attack: A survivor's retrospective
|
||||
...
|
||||
```
|
||||
|
||||
#### Example 2 - Longer content
|
||||
If a line of output is wider than 80 characters it gets output in a puts block for easier marking.
|
||||
|
||||
{% for post in site.posts %}
|
||||
{% puts %}
|
||||
Title: {{ post.title }}
|
||||
Content: {{ post.content }}
|
||||
{% endputs %}
|
||||
{% endfor %}
|
||||
|
||||
#### Output
|
||||
|
||||
```
|
||||
{% puts %}
|
||||
Title: Zombie Ninjas Attack: A survivor's retrospective
|
||||
Content: Spoiler: You don't want to survive this. So there I was, standing in line
|
||||
for a movie. I could hear hear some car alarms going off in the distance, but that
|
||||
....
|
||||
{% endputs %}
|
||||
...
|
||||
```
|
||||
|
||||
[« Plugins page](/docs/plugins)
|
Loading…
x
Reference in New Issue
Block a user