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] Add Note to Readme-Template about Variable Espansion #10983

Merged
merged 5 commits into from
Apr 6, 2020
Merged

[Docs] Add Note to Readme-Template about Variable Espansion #10983

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d0f4368
add note with Espansion VarNames
6543 Apr 6, 2020
b6894fa
Merge branch 'master' into docu_README-template
6543 Apr 6, 2020
7df85dc
add context of Name
6543 Apr 6, 2020
557e2e9
Merge branch 'master' into docu_README-template
6543 Apr 6, 2020
7ace76d
Merge branch 'master' into docu_README-template
6543 Apr 6, 2020
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
9 changes: 6 additions & 3 deletions docs/content/doc/advanced/customizing-gitea.en-us.md
View file
Open in desktop
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}`, `{Description}`, `{CloneURL.SSH}` and `{CloneURL.HTTPS}`
6543 marked this conversation as resolved.
Show resolved Hide resolved

### Reactions

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