Shortcode documentation update #2227
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Explain how shortcodes differ from Tera template function calls
I understand this is somewhat of an implementation detail, but it's required knowledge when you're trying to figure out why zola can't find your image.
Keats
approved these changes
Jun 5, 2023
Keats
reviewed
Jun 5, 2023
| @@ -72,6 +72,15 @@ There are two kinds of shortcodes: | |||
| In both cases, the arguments must be named and they will all be passed to the template. | |||
| Parentheses are mandatory even if there are no arguments. | |||
|
|
|||
| Note that while a shortcode looks like a normal Tera template call, it is limited in several ways: | |||
There was a problem hiding this comment.
It might be better to say that it is not actually Tera at all
There was a problem hiding this comment.
Sounds good -- I pushed some changes that clarify this a bit.
Drive home that shortcodes are completely unrelated to Tera
Good grammar speak
Keats
approved these changes
Jun 5, 2023
|
Thank you! |
biodranik
pushed a commit
to biodranik/zola
that referenced
this pull request
Sep 12, 2023
* Details about using shortcodes Explain how shortcodes differ from Tera template function calls * Add path search order to image processing docs I understand this is somewhat of an implementation detail, but it's required knowledge when you're trying to figure out why zola can't find your image. * Update shortcodes.md Drive home that shortcodes are completely unrelated to Tera * Update shortcodes.md Good grammar speak
technimad
pushed a commit
to technimad/zola
that referenced
this pull request
Sep 30, 2023
* Details about using shortcodes Explain how shortcodes differ from Tera template function calls * Add path search order to image processing docs I understand this is somewhat of an implementation detail, but it's required knowledge when you're trying to figure out why zola can't find your image. * Update shortcodes.md Drive home that shortcodes are completely unrelated to Tera * Update shortcodes.md Good grammar speak
Drodt
pushed a commit
to DerDrodt/zola
that referenced
this pull request
Oct 10, 2023
* Details about using shortcodes Explain how shortcodes differ from Tera template function calls * Add path search order to image processing docs I understand this is somewhat of an implementation detail, but it's required knowledge when you're trying to figure out why zola can't find your image. * Update shortcodes.md Drive home that shortcodes are completely unrelated to Tera * Update shortcodes.md Good grammar speak
fredr
pushed a commit
to fredr/zola
that referenced
this pull request
Oct 21, 2023
* Details about using shortcodes Explain how shortcodes differ from Tera template function calls * Add path search order to image processing docs I understand this is somewhat of an implementation detail, but it's required knowledge when you're trying to figure out why zola can't find your image. * Update shortcodes.md Drive home that shortcodes are completely unrelated to Tera * Update shortcodes.md Good grammar speak
selfisekai
pushed a commit
to selfisekai/zola
that referenced
this pull request
Nov 3, 2023
* Details about using shortcodes Explain how shortcodes differ from Tera template function calls * Add path search order to image processing docs I understand this is somewhat of an implementation detail, but it's required knowledge when you're trying to figure out why zola can't find your image. * Update shortcodes.md Drive home that shortcodes are completely unrelated to Tera * Update shortcodes.md Good grammar speak
Newbytee
pushed a commit
to Newbytee/zola
that referenced
this pull request
Dec 19, 2023
* Details about using shortcodes Explain how shortcodes differ from Tera template function calls * Add path search order to image processing docs I understand this is somewhat of an implementation detail, but it's required knowledge when you're trying to figure out why zola can't find your image. * Update shortcodes.md Drive home that shortcodes are completely unrelated to Tera * Update shortcodes.md Good grammar speak
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
IMPORTANT: Please do not create a Pull Request adding a new feature without discussing it first.
The place to discuss new features is the forum: https://zola.discourse.group/
If you want to add a new feature, please open a thread there first in the feature requests section.
Sanity check:
Clarifies some things about templates / shortcodes that tripped me up (see #2225).