nicosommi / k6-docs

The k6 documentation website.

k6 Documentation

This repo contains the source code of the k6 documentation.

Install and run in Docker

This uses docker-compose and port 8100.

git clone [e-mail]:loadimpact/k6-docs.git
cd k6-docs

docker-compose  up -d --build

Note that starting up the docker takes several minutes, during which the website will not be accessible. Use docker-compose log -f web to track progress.

Then visit http://localhost:8100

If you want to re-run the --build command you may get an error about not having access to delete a cache/ folder. Use sudo to delete this manually before retrying.

Manual Installation

This uses port 8000 by default.

git clone [e-mail]:loadimpact/k6-docs.git
cd k6-docs
npm install

Running manually:

npm start

Visit http://localhost:8000

Contributing

Documentation articles are markdown files structured under the src/data/markdown/docs folder.

The markdown files support a few custom extensions explained on the File Format Guide.