Skip to content

Commit bbec2b3

Browse files
authored
Merge pull request #949 from moodle/mermaid-intro
Add information about Mermaid to contributing.md
2 parents c14baf2 + 4d30dfc commit bbec2b3

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

general/documentation/contributing.md

+20
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,26 @@ When doing so you should may want to:
161161
- Flag issues that are stale or that should be closed.
162162
- Review code.
163163

164+
## Adding diagrams
165+
166+
The diagram tool [Mermaid](https://mermaid.js.org/intro/) is integrated into this docs site. This lets you define simple diagrams in the source of the page. For example:
167+
168+
````
169+
```mermaid
170+
flowchart LR
171+
WRITE[Write Mermaid code] --> Re-render --> Profit!
172+
```
173+
````
174+
175+
... which produces:
176+
177+
```mermaid
178+
flowchart LR
179+
WRITE[Write Mermaid code] --> Re-render --> Profit!
180+
```
181+
182+
To work out the Mermaid syntax you need for the diagram you are trying to create, the [Live editor](https://mermaid.live/) is highly recommended.
183+
164184
## Our Development Process
165185

166186
While our development of Moodle is managed in the [Moodle Tracker](https://tracker.moodle.org/), all development of these Developer Resources takes place in this [GitHub repository](https://github.com/moodle/devdocs). All work takes place in public, in this repository.

0 commit comments

Comments
 (0)