🚀 New! Kestra raises $3 million to grow Learn more

Requirements

The following dependencies are required to build Kestra docs locally:

  • Node 14+ and npm
  • an IDE (Webstorm or VS Code)

To start contributing:

  • Fork the repository
  • Clone the fork on your workstation:
shell
$ git clone git@github.com:{YOUR_USERNAME}/docs.git
$ cd docs

Develop

Use the following commands to serve the docs locally:

shell
# install dependencies
$ npm install

# serve with hot reload at localhost:3001
$ npm run dev

# to generate static pages
$ npm run generate

# making a production build
$ npm run build