Documentation for Test Kitchen.
The Getting Started guide is written in Markdown and rendered using Hugo.
All documentation will be hosted on the official Kitchen website http://kitchen.ci, which is a static site stored in an S3 bucket and fronted by CloudFront.
- On macOS run:
brew install hugo - On Windows run:
choco install hugo - On Ubuntu run:
apt install -y build-essential; snap install hugo --channel=extended
Run hugo serve and browse the the URL presented
There are four elements that may be used for "styling" the docs content: in-line code highlighting, code blocks, blockquotes, and a special hack around markdown tables that we'll use for what we call "Pro-Tips".
To highlight some code inline with other content, just "quote" the text using backtick characters (`).
To highlight a block of code, start and finish the block with three or more tilde characters (~). To enable syntax-highlighting, just indicate the code language after the tildes on the first line.
For example, this code:
~~~yaml
---
title: "KitchenCI Overview"
next:
url: installing-kitchen
text: "Installing KitchenCI"
---
~~~
...will yield this output:
---
title: "KitchenCI Overview"
next:
url: installing-kitchen
text: "Installing KitchenCI"
---See the kramdown documentation for more information.
To draw attention to some content with a blockquote, just start the line(s) with a > (right angle bracket / greater than symbol). See the kramdown documentation for more information.
The Kitchen Documentation is released under the MIT license.