This repo contains the source code of the k6 documentation.
This uses docker-compose
and port 8100
.
git clone [email protected]: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 logs -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 acache/
folder. Usesudo
to delete this manually before retrying.
This uses port 8000
by default.
git clone [email protected]:loadimpact/k6-docs.git
cd k6-docs
npm install
Running manually:
npm start
Visit http://localhost:8000
All pull requests merged to master
will result in an automatic deployment to the staging environment.
All tags created using the format vN.N.N
, for instance v0.0.1
, will result in an automatic deployment to the production environment. Tags can either be created and pushed from the git cli, or from https://github.com/loadimpact/k6-docs/releases
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.