Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve shortcode name documentation to specify first-letter rule #2655

Merged
merged 1 commit into from
Sep 29, 2024
Merged

Improve shortcode name documentation to specify first-letter rule #2655

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/content/documentation/content/shortcodes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,9 @@ pretty much just shuttle arguments to their template. Several limitions of note
If the shortcode is invalid, it will not be interpreted by the markdown parser and will instead
get rendered directly into the final HTML.

Lastly, a shortcode name (and thus the corresponding `.html` file) as well as the argument names
can only contain numbers, letters and underscores, or in Regex terms `[0-9A-Za-z_]`.
Although theoretically an argument name could be a number, it will not be possible to use such an argument in the template.
Lastly, a shortcode name (and thus the corresponding `.html` file) as well as any argument names
can only contain numbers, letters and underscores, and must start with a letter or underscore.
In Regex terms, `^[A-Za-z_][0-9A-Za-z_]+$`.

Argument values can be of one of five types:

Expand Down