mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-09-06 22:33:14 +00:00
[Docs] Add Note to Readme-Template about Variable Espansion (#10983)
* add note with Espansion VarNames * add context of Name
This commit is contained in:
parent
d79ff1dd32
commit
17837986f0
1 changed files with 6 additions and 3 deletions
|
@ -150,8 +150,8 @@ Mermaid will detect and use tags with `class="language-mermaid"`.
|
||||||
#### Example: PlantUML
|
#### Example: PlantUML
|
||||||
|
|
||||||
You can add [PlantUML](https://plantuml.com/) support to Gitea's markdown by using a PlantUML server.
|
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
|
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
|
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,
|
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
|
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`:
|
`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
|
```plantuml
|
||||||
Alice -> Bob: Authentication Request
|
Alice -> Bob: Authentication Request
|
||||||
Bob --> Alice: Authentication Response
|
Bob --> Alice: Authentication Response
|
||||||
|
|
||||||
Alice -> Bob: Another authentication Request
|
Alice -> Bob: Another authentication Request
|
||||||
Alice <-- Bob: Another authentication Response
|
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`
|
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
|
### Reactions
|
||||||
|
|
||||||
To change reaction emoji's you can set allowed reactions at app.ini
|
To change reaction emoji's you can set allowed reactions at app.ini
|
||||||
|
|
Loading…
Reference in a new issue