Skip to content

Commit fd60497

Browse files
copyedit checklist readme
1 parent 8dd963e commit fd60497

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

plugins/filters/checklist/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
--8<-- "plugins/filters/checklist/reference.md"
2+
3+
With this plugin, you can easily customize the checklist using the object in the JavaScript code. To add a new check to the list, just add a new object with a descriptive `title` for your own benefit, a `label` that'll get posted in the comment, and the `condition` that, if true, would cause the entry in the checklist to be checked off.
4+
15
??? note "Plugin Code: checklist"
26
```javascript
37
--8<-- "plugins/filters/checklist/index.js"
@@ -7,7 +11,6 @@
711
</span>
812
</div>
913

10-
With this plugin, you can easily customize the checklist using the object in the JavaScript code. To add a new check to the list, just add a new object with a descriptive `title` for your own benefit, a `label` that'll get posted in the comment, and the `condition` that, if true, would cause the entry in the checklist to be checked off.
1114

1215
??? example "gitStream CM Example: checklist"
1316
```yaml+jinja
@@ -19,3 +22,5 @@ With this plugin, you can easily customize the checklist using the object in the
1922
</div>
2023

2124
[Download Source Code](https://github.com/linear-b/gitstream/tree/main/plugins/filters/checklist)
25+
26+

0 commit comments

Comments
 (0)