Docs: shortcodes: Mention argument parens are mandatory #1752
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
Keats
reviewed
Feb 6, 2022
| @@ -130,6 +131,29 @@ A quote | |||
| The body of the shortcode will be automatically passed down to the rendering context as the `body` variable and needs | |||
| to be on a new line. | |||
|
|
|||
| ### Shortcodes with no arguments | |||
There was a problem hiding this comment.
Is that necessary with the paragraph change above?
There was a problem hiding this comment.
Having an example of an arguments-less shortcode instantiation will help people who are skimming the page.
I personally tried copying the body example, deleted the arguments, and was wondering why it wasn't working; I figure that there will be others like me.
thomasantony
pushed a commit
to thomasantony/zola
that referenced
this pull request
Sep 17, 2022
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:
I wanted to create an
asideshortcode to decouple content structuring from its HTML rendering (trying to keep HTML out of my Markdown), and was struggling to figure out why my shortcode wasn't rendering.An unrelated search for something else brought me here, which ended up solving my problem for me. Figured I'd bring it across to the docs for the next poor sap to come by! 😆