You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+17Lines changed: 17 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -126,6 +126,23 @@ Note that you can run
126
126
127
127
For ktlint to fix some detected errors for you (you still have to check and commit the fix of course)
128
128
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
0 commit comments