Roman Elizarov | b3d55a5 | 2017-02-03 12:47:21 +0300 | [diff] [blame] | 1 | # Knit |
| 2 | |
| 3 | This is a very simple tool that produces Kotlin source example files from a markdown document that includes |
| 4 | snippets of Kotlin code in its body. It is used to produce examples for |
Roman Elizarov | f23274a | 2017-05-17 13:27:30 +0300 | [diff] [blame] | 5 | [coroutines guide](../coroutines-guide.md) and other markdown documents. |
Roman Elizarov | 6c18dfd | 2017-06-23 13:27:02 +0300 | [diff] [blame] | 6 | It also includes links to the documentation web site into the documents. |
Roman Elizarov | b3d55a5 | 2017-02-03 12:47:21 +0300 | [diff] [blame] | 7 | |
Roman Elizarov | f23274a | 2017-05-17 13:27:30 +0300 | [diff] [blame] | 8 | ## Usage |
Roman Elizarov | 419a6c8 | 2017-02-09 18:36:22 +0300 | [diff] [blame] | 9 | |
| 10 | * In project root directory do: |
Kirill Timofeev | a518696 | 2017-10-25 14:25:47 +0300 | [diff] [blame] | 11 | * Run `./gradlew knit` |
Roman Elizarov | f23274a | 2017-05-17 13:27:30 +0300 | [diff] [blame] | 12 | * Commit updated documents and examples |
Kirill Timofeev | a518696 | 2017-10-25 14:25:47 +0300 | [diff] [blame] | 13 | |