Skip to content

Update readme #41

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

Merged
spekary merged 1 commit into from
Jan 29, 2026
Merged

Update readme #41

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
11 changes: 4 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,10 +371,10 @@ inserted into the template at that spot. You can include the `{{` or `{{g` tags
force the processor into the text or go modes if needed. The fragment can be defined
any time before it is included, including being defined in other include files.

You can add optional parameters
to a fragment that will be substituted for placeholders when the fragment is used. You can have up to 9
placeholders ($1 - $9). Parameters should be separated by commas, and can be surrounded by quotes if needed
to have a parameter that has a quote or comma in it.
You can add optional parameters to a fragment that will be substituted for placeholders when the fragment is used.
You can have up to 9 placeholders ($1 - $9). Parameters should be separated by commas, and can be surrounded by quotes or backticks
if needed to pass a parameter that has a quote or comma in it.
If a parameter is not included when using a fragment, an empty value will be substituted for the parameter in the fragment.

{{< fragName }} or {{define fragName }} Start a block called "fragName".
{{< fragName <count>}} or Start a block called "fragName" that will
Expand All @@ -389,9 +389,6 @@ to have a parameter that has a quote or comma in it.
If you attempt to use a fragment that was not previously defined, GoT will panic and stop compiling,
unless you use {{>? or {{put? to include the fragment.

param1, param2, ... are optional parameters that will be substituted for $1, $2, ... in the defined fragment.
If a parameter is not included when using a fragment, an empty value will be substituted for the parameter in the fragment.

The fragment name is NOT surrounded by quotes, and cannot contain any whitespace in the name. Blocks are ended with a
`{{end fragName}}` tag. The end tag must be just like that, with no spaces after the fragName.

Expand Down