Skip to content

Commit 1783798

Browse files
authored
[Docs] Add Note to Readme-Template about Variable Espansion (#10983)
* add note with Espansion VarNames * add context of Name
1 parent d79ff1d commit 1783798

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/content/doc/advanced/customizing-gitea.en-us.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,8 @@ Mermaid will detect and use tags with `class="language-mermaid"`.
150150
#### Example: PlantUML
151151

152152
You can add [PlantUML](https://plantuml.com/) support to Gitea's markdown by using a PlantUML server.
153-
The data is encoded and sent to the PlantUML server which generates the picture. There is an online
154-
demo server at http://www.plantuml.com/plantuml, but if you (or your users) have sensitive data you
153+
The data is encoded and sent to the PlantUML server which generates the picture. There is an online
154+
demo server at http://www.plantuml.com/plantuml, but if you (or your users) have sensitive data you
155155
can set up your own [PlantUML server](https://plantuml.com/server) instead. To set up PlantUML rendering,
156156
copy javascript files from https://gitea.com/davidsvantesson/plantuml-code-highlight and put them in your
157157
`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:
173173
```plantuml
174174
Alice -> Bob: Authentication Request
175175
Bob --> Alice: Authentication Response
176-
176+
177177
Alice -> Bob: Another authentication Request
178178
Alice <-- Bob: Another authentication Response
179179
```
@@ -235,6 +235,9 @@ Locales may change between versions, so keeping track of your customized locales
235235

236236
To add a custom Readme, add a markdown formatted file (without an `.md` extension) to `custom/options/readme`
237237

238+
**NOTE:** readme templates support **variable expansion**.
239+
currently there are `{Name}` (name of repository), `{Description}`, `{CloneURL.SSH}` and `{CloneURL.HTTPS}`
240+
238241
### Reactions
239242

240243
To change reaction emoji's you can set allowed reactions at app.ini

0 commit comments

Comments
 (0)