From 17837986f0583e8520ea8994bfcf214e7951f5ca Mon Sep 17 00:00:00 2001
From: 6543 <6543@obermui.de>
Date: Tue, 7 Apr 2020 01:43:17 +0200
Subject: [PATCH] [Docs] Add Note to Readme-Template about Variable Espansion
(#10983)
* add note with Espansion VarNames
* add context of Name
---
docs/content/doc/advanced/customizing-gitea.en-us.md | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/docs/content/doc/advanced/customizing-gitea.en-us.md b/docs/content/doc/advanced/customizing-gitea.en-us.md
index 73127dd81a..f0ddc4698b 100644
--- a/docs/content/doc/advanced/customizing-gitea.en-us.md
+++ b/docs/content/doc/advanced/customizing-gitea.en-us.md
@@ -150,8 +150,8 @@ Mermaid will detect and use tags with `class="language-mermaid"`.
#### 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
-demo server at http://www.plantuml.com/plantuml, but if you (or your users) have sensitive data you
+The data is encoded and sent to the PlantUML server which generates the picture. There is an online
+demo server at http://www.plantuml.com/plantuml, but if you (or your users) have sensitive data you
can set up your own [PlantUML server](https://plantuml.com/server) instead. To set up PlantUML rendering,
copy javascript files from https://gitea.com/davidsvantesson/plantuml-code-highlight and put them in your
`custom/public` folder. Then add the following to `custom/footer.tmpl`:
@@ -173,7 +173,7 @@ You can then add blocks like the following to your markdown:
```plantuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
-
+
Alice -> Bob: Another authentication Request
Alice <-- Bob: Another authentication Response
```
@@ -235,6 +235,9 @@ Locales may change between versions, so keeping track of your customized locales
To add a custom Readme, add a markdown formatted file (without an `.md` extension) to `custom/options/readme`
+**NOTE:** readme templates support **variable expansion**.
+currently there are `{Name}` (name of repository), `{Description}`, `{CloneURL.SSH}` and `{CloneURL.HTTPS}`
+
### Reactions
To change reaction emoji's you can set allowed reactions at app.ini