diff options
| author | silverwind <me@silverwind.io> | 2020-07-27 08:24:09 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-27 02:24:09 -0400 |
| commit | 4315e313d12bbf0655710b6ab0aad121e0f7dba2 (patch) | |
| tree | dfcc816a013288f5112f3be4f38ac183557220fb /docs/content/doc | |
| parent | 46ef562a161a2685d429ffd7dc594383de533c07 (diff) | |
| download | gitea-4315e313d12bbf0655710b6ab0aad121e0f7dba2.tar.gz gitea-4315e313d12bbf0655710b6ab0aad121e0f7dba2.zip | |
Add mermaid JS renderer (#12334)
* Add mermaid JS renderer
For feature parity with GitLab. Tested in files, issues, wiki, editor.
arc-green only does an inversion because the renderer seems to like to
render white backgrounds on boxes.
Ref: https://github.com/go-gitea/gitea/issues/3340
Fixes: https://github.com/go-gitea/gitea/issues/12307
* add feature entry, switch to neutral theme, remove border
* add bindFunctions support
* remove unnecessary border-radius
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
Diffstat (limited to 'docs/content/doc')
| -rw-r--r-- | docs/content/doc/advanced/customizing-gitea.en-us.md | 39 |
1 files changed, 0 insertions, 39 deletions
diff --git a/docs/content/doc/advanced/customizing-gitea.en-us.md b/docs/content/doc/advanced/customizing-gitea.en-us.md index d6a2019ac0..6bc7be4ad0 100644 --- a/docs/content/doc/advanced/customizing-gitea.en-us.md +++ b/docs/content/doc/advanced/customizing-gitea.en-us.md @@ -108,45 +108,6 @@ Apart from `extra_links.tmpl` and `extra_tabs.tmpl`, there are other useful temp - `body_outer_post.tmpl`, before the bottom `<footer>` element. - `footer.tmpl`, right before the end of the `<body>` tag, a good place for additional Javascript. -#### Example: Mermaid.js - -If you would like to add [mermaid.js](https://mermaid-js.github.io/mermaid) support to Gitea's markdown you simply add: - -```html -{{if .RequireHighlightJS}} -<script src="https://unpkg.com/mermaid@8.4.5/dist/mermaid.min.js"></script> -<!-- or wherever you have placed it --> -<script>mermaid.init(".language-mermaid")</script> -{{end}} -``` - -to `custom/footer.tmpl`. You then can add blocks -like below to your markdown: - - ```mermaid - stateDiagram - [*] --> Active - - state Active { - [*] --> NumLockOff - NumLockOff --> NumLockOn : EvNumLockPressed - NumLockOn --> NumLockOff : EvNumLockPressed - -- - [*] --> CapsLockOff - CapsLockOff --> CapsLockOn : EvCapsLockPressed - CapsLockOn --> CapsLockOff : EvCapsLockPressed - -- - [*] --> ScrollLockOff - ScrollLockOff --> ScrollLockOn : EvCapsLockPressed - ScrollLockOn --> ScrollLockOff : EvCapsLockPressed - } - ``` - -If you want to use Mermaid.js outside of markdown, e.g. in other templates or HTML files, -you would need to remove `{{if .RequireHighlightJS}}` and `{{end}}`. - -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. |