Skip to content

Commit deb4730

Browse files
committed
Add section about knit tool
1 parent 211c0c2 commit deb4730

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,23 @@ Note that you can run
126126

127127
For ktlint to fix some detected errors for you (you still have to check and commit the fix of course)
128128

129+
#### knit
130+
131+
[knit](https://github.com/Kotlin/kotlinx-knit) is a tool which checks markdown files on the project. Also it generates/updates the table of content (toc) of the markdown files.
132+
133+
So everytime the toc should be updated, just run
134+
<pre>
135+
./gradlew knit
136+
</pre>
137+
138+
and commit the changes.
139+
140+
The CI will check that markdown files are up to date by running
141+
142+
<pre>
143+
./gradlew knitCheck
144+
</pre>
145+
129146
#### lint
130147

131148
<pre>

0 commit comments

Comments
 (0)