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

Jump to bottom

docs: template variables #26547

Merged
merged 7 commits into from
Aug 19, 2023
Merged

docs: template variables #26547

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c7c3527
docs: template variables
lonix1 Aug 16, 2023
eb715d4
docs: wording
lonix1 Aug 16, 2023
59aaf0b
Merge branch 'main' into lonix1-patch-1
lonix1 Aug 16, 2023
a75d8ab
fix: linting error
lonix1 Aug 16, 2023
5f7a30d
fix: docs sections at wrong level
lonix1 Aug 16, 2023
aaa3e97
Merge branch 'main' into lonix1-patch-1
lonix1 Aug 16, 2023
5ab3184
Merge branch 'main' into lonix1-patch-1
GiteaBot Aug 19, 2023
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
14 changes: 12 additions & 2 deletions docs/content/administration/customizing-gitea.en-us.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,17 @@ Apart from `extra_links.tmpl` and `extra_tabs.tmpl`, there are other useful temp
- `body_outer_post.tmpl`, before the bottom `<footer>` element.
- `footer.tmpl`, right before the end of the `<body>` tag, a good place for additional JavaScript.

#### Example: PlantUML
### Using Gitea variables

It's possible to use various Gitea variables in your custom templates.

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.

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}}`.

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.

### Example: PlantUML

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

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

#### Example: STL Preview
### Example: STL Preview

You can display STL file directly in Gitea by adding:

Expand Down