developer.konghq.com

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

developer.konghq.com

★ 27 Open GitHub ↗

🦍 Source code for developer.konghq.com website.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# developer.konghq.com

🦍 Source code for developer.konghq.com website.

## Prerequisites

- [mise](https://mise.jdx.dev/getting-started.html).
    - Optionally configure your shell to [activate mise](https://mise.jdx.dev/getting-started.html#activate-mise) automatically.
    - You may need to run `mise trust` when first opening a new repository.
- [libyaml](https://github.com/yaml/libyaml).

## Run Locally

```bash
# 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](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.

## Generating specific products locally

Building the entire docs site can take a while. To speed up build times, you can generate a specific subset of products by setting the `KONG_PRODUCTS` environment variable. This variable accepts a comma-separated list of products (product slugs as defined in `app/_data/products`), e.g `KONG_PRODUCTS=ai-gateway make run`.

## Generating specific pages locally

You can generate specific pages by setting the PAGE_PATHS environment variable. This variable accepts a comma-separated list of paths. For example:

```sh
PAGE_PATHS="/plugins/acme/,/gateway/entities/" make run
```

The platform will generate all pages that match each specified path. For instance, `/gateway/entities/` will generate all pages whose paths start with `/gateway/entities/`.

## Contributing to the docs

If you want to contribute to the Kong Developer docs, see the [Contributing guide](https://developer.konghq.com/contributing/).

developer.konghq.com

Today's picks

Was this content helpful?

Recent Feedback

developer.konghq.com

Today's picks

Was this content helpful?

Recent Feedback

Download README