Skip to content

Commit 8f93648

Browse files
authored
docs: template variables (#26547)
Explanation for using gitea's variables in `.tmpl` files. Thanks to @wxiaoguang for advising me on [discord](https://discord.com/channels/322538954119184384/561007778139734027/1141217820441587722).
1 parent 00cf36d commit 8f93648

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

docs/content/administration/customizing-gitea.en-us.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,17 @@ Apart from `extra_links.tmpl` and `extra_tabs.tmpl`, there are other useful temp
126126
- `body_outer_post.tmpl`, before the bottom `<footer>` element.
127127
- `footer.tmpl`, right before the end of the `<body>` tag, a good place for additional JavaScript.
128128

129-
#### Example: PlantUML
129+
### Using Gitea variables
130+
131+
It's possible to use various Gitea variables in your custom templates.
132+
133+
First, _temporarily_ enable development mode: in your `app.ini` change from `RUN_MODE = prod` to `RUN_MODE = dev`. Then add `{{ $ | DumpVar }}` to any of your templates, restart Gitea and refresh that page; that will dump all available variables.
134+
135+
Find the data that you need, and use the corresponding variable; for example, if you need the name of the repository then you'd use `{{.Repository.Name}}`.
136+
137+
If you need to transform that data somehow, and aren't familiar with Go, an easy workaround is to add the data to the DOM and add a small JavaScript script block to manipulate the data.
138+
139+
### Example: PlantUML
130140

131141
You can add [PlantUML](https://plantuml.com/) support to Gitea's markdown by using a PlantUML server.
132142
The data is encoded and sent to the PlantUML server which generates the picture. There is an online
@@ -162,7 +172,7 @@ Alice <-- Bob: Another authentication Response
162172

163173
The script will detect tags with `class="language-plantuml"`, but you can change this by providing a second argument to `parsePlantumlCodeBlocks`.
164174

165-
#### Example: STL Preview
175+
### Example: STL Preview
166176

167177
You can display STL file directly in Gitea by adding:
168178

0 commit comments

Comments
 (0)