Synchronized build
This commit is contained in:
Lektor Bot
parent
d0fe7a1937
commit
39f11d4455
|
|
@ -151,7 +151,7 @@ speak multiple languages and allow you to easily create localized websites.</li>
|
|||
<div class="slideshow-wrapper">
|
||||
<div class="slideshow">
|
||||
<div class="slideshow-inner">
|
||||
<div class="carousel slide" data-ride="carousel" data-interval="8500" id="carousel-cf624a833d7c4a0e831ad6e6e37798f6">
|
||||
<div class="carousel slide" data-ride="carousel" data-interval="8500" id="carousel-a1dd43705485419bb95501b597897b63">
|
||||
|
||||
<div class="carousel-inner" role="listbox">
|
||||
|
||||
|
|
@ -210,11 +210,11 @@ be completely customized.</p>
|
|||
</div>
|
||||
|
||||
</div>
|
||||
<a class="left carousel-control" href="#carousel-cf624a833d7c4a0e831ad6e6e37798f6" role="button" data-slide="prev">
|
||||
<a class="left carousel-control" href="#carousel-a1dd43705485419bb95501b597897b63" role="button" data-slide="prev">
|
||||
<span class="glyphicon glyphicon-chevron-left" aria-hidden="true"></span>
|
||||
<span class="sr-only">Previous</span>
|
||||
</a>
|
||||
<a class="right carousel-control" href="#carousel-cf624a833d7c4a0e831ad6e6e37798f6" role="button" data-slide="next">
|
||||
<a class="right carousel-control" href="#carousel-a1dd43705485419bb95501b597897b63" role="button" data-slide="next">
|
||||
<span class="glyphicon glyphicon-chevron-right" aria-hidden="true"></span>
|
||||
<span class="sr-only">Next</span>
|
||||
</a>
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@
|
|||
<div class="plugin">
|
||||
<div class="row">
|
||||
<div class="col-sm-12">
|
||||
<h1>Plugin – lektor-shortcodes 0.2.5</h1>
|
||||
<h1>Plugin – lektor-shortcodes 0.2.7</h1>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -96,7 +96,7 @@
|
|||
<div class="separator">
|
||||
<h4>Meta</h4>
|
||||
</div>
|
||||
<p><strong>Version:</strong> 0.2.5</p>
|
||||
<p><strong>Version:</strong> 0.2.7</p>
|
||||
<p><strong>Author:</strong>
|
||||
|
||||
<a href="mailto:hi@stavros.io">Stavros Korokithakis,,,</a>
|
||||
|
|
@ -133,7 +133,70 @@
|
|||
<div class="col-sm-9 doc-styling">
|
||||
<h2>Project Description</h2>
|
||||
|
||||
Lektor Shortcodes<br>=================<br><br>[](https://pypi.python.org/pypi/lektor-shortcodes)<br><br>The Lektor Shortcodes plugin allows you to use shortcodes (shortcodes are<br>something like custom tags) in your fields (not templates), so your content<br>doesn't have to have repetitive snippets over and over.<br><br>For example, my blog has some specific HTML that I add when I want an image with<br>a border and caption to be displayed. The HTML looks like this:<br><br><br>~~~html<br> <div class="alignright"><br> <a href="image-large.jpg"><br> <img src="image.jpg" /><br> <span class="caption">The caption</span><br> </a><br> </div><br>~~~<br><br>Copy-pasting this every time gets tedious, and I have to search and replace it<br>in all the content files every time I want to make a change. With the<br>shortcodes plugin, this can be written as:<br><br>~~~<br>[% image align=right link="image-large.jpg" image=image.jpg caption="The caption" %]<br>~~~<br><br>Much easier, cleaner and less repetitive.<br><br><br>Installation<br>------------<br><br>To install the plugin, just add `lektor-shortcodes` to your plugins from the<br>command line:<br><br>~~~<br>lektor plugins add lektor-shortcodes<br>~~~<br><br><br>Usage<br>-----<br><br>Using the plugin is simple. Just create a config file called `shortcodes.ini` in<br>your `configs` directory and specify some shortcode templates. The templates are<br>full Jinja templates, although (due to some limitations of ini files) they need<br>to be on one line.<br><br>For instance, for the example above, the config file could be:<br><br>~~~ini<br>[global]<br>image = '<div class="align{{ align }}">{% if link %}<a href="{{ link }}"{% if not link.startswith("http") %} data-lightbox="gallery"{% endif %}>{% endif %}<img src="{{ image }}">{% if link %}</a>{% endif %}{% if caption %}<span class="caption">{{ caption }}</span>{% endif %}</div>'<br>~~~<br><br>This will allow you to use shortcodes with optional arguments, like so:<br><br>~~~<br># An image with no caption or link:<br>[% image align=right image=hello.jpg %]<br><br><br># An image with a link:<br>[% image align=right link=http://www.example.com image=hello.jpg %]<br><br># Link and caption:<br>[% image align=right link=http://www.example.com image=hello.jpg caption="Hello!" %]<br>~~~<br><br>Shortcodes defined within the section named `global` will be processed<br>automatically inside any of your site’s Markdown content. It is also possible to<br>define shortcodes which are only expanded when the Jinja2 template for a page<br>explicitly requests it. Shortcodes defined in any section not named `global`<br>will only be applied when the template passed the content through a Jinja2<br>filter named `shortcode`. For example, if your HTML template references a field<br>called `body`, you may request expanding shortcodes defined within the<br>`body-only` section of your config file, like so:<br><br>~~~<br>{{ body|shortcodes(section="body-only") }}<br>~~~<br><br>This will enable all shortcodes from the specified section, in addition to all<br>globally defined shortcodes. If no section is specified, the filter defaults to<br>the section named `main`.<br><br><br>Miscellanea<br>-----------<br><br>If you find a bug or have a feature request, please open an issue or file a PR.<br>Thanks!<br>
|
||||
<h1>Lektor Shortcodes</h1>
|
||||
<p><a href="https://pypi.python.org/pypi/lektor-shortcodes" rel="nofollow"><img src="https://img.shields.io/pypi/v/lektor-shortcodes.svg" alt="PyPI"></a></p>
|
||||
<p>The Lektor Shortcodes plugin allows you to use shortcodes (shortcodes are
|
||||
something like custom tags) in your fields (not templates), so your content
|
||||
doesn't have to have repetitive snippets over and over.</p>
|
||||
<p>For example, my blog has some specific HTML that I add when I want an image with
|
||||
a border and caption to be displayed. The HTML looks like this:</p>
|
||||
<pre lang="html"> <span class="p"><</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">"alignright"</span><span class="p">></span>
|
||||
<span class="p"><</span><span class="nt">a</span> <span class="na">href</span><span class="o">=</span><span class="s">"image-large.jpg"</span><span class="p">></span>
|
||||
<span class="p"><</span><span class="nt">img</span> <span class="na">src</span><span class="o">=</span><span class="s">"image.jpg"</span> <span class="p">/></span>
|
||||
<span class="p"><</span><span class="nt">span</span> <span class="na">class</span><span class="o">=</span><span class="s">"caption"</span><span class="p">></span>The caption<span class="p"></</span><span class="nt">span</span><span class="p">></span>
|
||||
<span class="p"></</span><span class="nt">a</span><span class="p">></span>
|
||||
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||||
</pre>
|
||||
<p>Copy-pasting this every time gets tedious, and I have to search and replace it
|
||||
in all the content files every time I want to make a change. With the
|
||||
shortcodes plugin, this can be written as:</p>
|
||||
<pre><code>[% image align=right link="image-large.jpg" image=image.jpg caption="The caption" %]
|
||||
</code></pre>
|
||||
<p>Much easier, cleaner and less repetitive.</p>
|
||||
<h2>Installation</h2>
|
||||
<p>To install the plugin, just add <code>lektor-shortcodes</code> to your plugins from the
|
||||
command line:</p>
|
||||
<pre><code>lektor plugins add lektor-shortcodes
|
||||
</code></pre>
|
||||
<h2>Usage</h2>
|
||||
<p>Using the plugin is simple. Just create a config file called <code>shortcodes.ini</code> in
|
||||
your <code>configs</code> directory and specify some shortcode templates. The templates are
|
||||
full Jinja templates, although (due to some limitations of ini files) they need
|
||||
to be on one line.</p>
|
||||
<p>For instance, for the example above, the config file could be:</p>
|
||||
<pre lang="ini"><span class="k">[global]</span>
|
||||
<span class="na">image</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">'<div class="align{{ align }}">{% if link %}<a href="{{ link }}"{% if not link.startswith("http") %} data-lightbox="gallery"{% endif %}>{% endif %}<img src="{{ image }}">{% if link %}</a>{% endif %}{% if caption %}<span class="caption">{{ caption }}</span>{% endif %}</div>'</span>
|
||||
</pre>
|
||||
<p>This will allow you to use shortcodes with optional arguments, like so:</p>
|
||||
<pre><code># An image with no caption or link:
|
||||
[% image align=right image=hello.jpg %]
|
||||
|
||||
|
||||
# An image with a link:
|
||||
[% image align=right link=http://www.example.com image=hello.jpg %]
|
||||
|
||||
# Link and caption:
|
||||
[% image align=right link=http://www.example.com image=hello.jpg caption="Hello!" %]
|
||||
</code></pre>
|
||||
<p>Shortcodes defined within the section named <code>global</code> will be processed
|
||||
automatically inside any of your site’s Markdown content. It is also possible to
|
||||
define shortcodes which are only expanded when the Jinja2 template for a page
|
||||
explicitly requests it. Shortcodes defined in any section not named <code>global</code>
|
||||
will only be applied when the template passed the content through a Jinja2
|
||||
filter named <code>shortcode</code>. For example, if your HTML template references a field
|
||||
called <code>body</code>, and your config has a section called <code>[special]</code>, you may request
|
||||
expanding shortcodes defined within the <code>special</code> section like so:</p>
|
||||
<pre><code>{{ body|shortcodes(section="special") }}
|
||||
</code></pre>
|
||||
<p>This will enable all shortcodes from the specified section, in addition to all
|
||||
globally defined shortcodes. If no section is specified, the filter defaults to
|
||||
the section named <code>main</code> (so it will include shortcodes in <code>main</code> unless you
|
||||
request a different section, and it will always include shortcodes in <code>global</code> no
|
||||
matter what).</p>
|
||||
<h2>Miscellanea</h2>
|
||||
<p>If you find a bug or have a feature request, please open an issue or file a PR.
|
||||
Thanks!</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue