Skip to content

Commit ce7a342

Browse files
authored
Update CONTRIBUTING.md
1 parent 7912198 commit ce7a342

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,29 @@ Documentation parts can be shared across helpers. Those parts are located in `do
131131
// ...
132132
}
133133
```
134+
_Note:_ Due to the (lib)[https://documentation.js.org/] that we are using to generate docs, the fast and cheap way to fix format issue that text after the mustache template is appended without formatting is moving the texts to above the mustache template.
135+
136+
```js
137+
/**
138+
* // Before
139+
* Click action
140+
* {{> click }}
141+
* Click action
142+
*/
143+
click() {
144+
// ...
145+
}
146+
147+
148+
```js
149+
/**
150+
* // After
151+
* Click action
152+
* {{> click }}
153+
*/
154+
click() {
155+
// ...
156+
}
134157
135158
## Typings
136159

0 commit comments

Comments
 (0)