developer.konghq.com

🦍 Source code for developer.konghq.com website.

Run Locally

Make sure you have mise

If you want to make sure you will always use the right version of tools, activate mise.

# Install dependencies
make install

# Create local .env file
# OAS Pages require VITE_PORTAL_API_URL to be set in your current environment, it should match the Kong supplied portal URL
cp .env.example .env

# Build the site and watch for changes 
make run

Once you see the Server now ready on … message, the docs site is available at http://localhost:8888.

Note: By default, some page generation is skipped for performance reasons. To generate the entire site locally, go to jekyll-dev.yml in the root of the repo and comment out the entire skip section.

Contributing to the docs

If you want to contribute to the Kong Developer docs, see the Contributing guide.