Skip to content

Commit

Permalink
[Docs] Add Note to Readme-Template about Variable Espansion (#10983)
Browse files Browse the repository at this point in the history
* add note with Espansion VarNames

* add context of Name
  • Loading branch information
6543 committed Apr 6, 2020
1 parent d79ff1d commit 1783798
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/content/doc/advanced/customizing-gitea.en-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand All @@ -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
```
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 1783798

Please sign in to comment.