aboutsummaryrefslogtreecommitdiff
path: root/knit/README.md
blob: 48114ec2c7ad65cb914b9704dc4ba271f54724f8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# Knit

This is a very simple tool that produces Kotlin source example files from a markdown document that includes
snippets of Kotlin code in its body. It is used to produce examples for 
[coroutines guide](../coroutines-guide.md) and other markdown documents.
It also includes links to the documentation web site into the documents.

## Usage

* In project root directory do:
  * Run `mvn clean compile site`
  * Add `-DskipJekyll` if you have don't Jekyll installed or don't want to actually rebuild documentation web 
    site static pages
* Commit updated documents and examples