ngrok docs

Source code for ngrok docs; feel free to suggest changes and improvements to our documentation!

Contributing

See our Contribution Guidelines for detailed instructions on how to help improve ngrok documentation.

Getting Started

ngrok is built using Docusaurus 3.

The fastest and safest (isolated) way to run the documentation is with the Docker command below, then browse to http://localhost:3000/docs.

docker run --rm -p 3000:3000 -it --name=ngrokDocs -v "./:/app" -w "/app" --platform=linux/amd64 guergeiro/pnpm:20-8-alpine sh -c "apk add direnv; direnv allow; pnpm install; pnpm run start"

Otherwise, you can install and run everything on your local host.

Prerequisites required:

We use direnv to assist you with setting up all of the required tooling.

Prefer to install and manage the tooling yourself?

Install nvm or your node version manager of choice.
Ensure that node 20 is installed. With nvm, run nvm install.
Enable pnpm with corepack: corepack enable pnpm
Install pnpm with corepack: corepack install
Install project dependencies with pnpm: pnpm install

First, install direnv:

OS	command
macOS	brew install direnv
ubuntu	sudo apt install direnv

For all other OSes, see the direnv installation guide.

Don't forget to set up direnv integration with your shell.

Next, clone the repo and move into the directory:

git clone https://github.com/ngrok/ngrok-docs.git
cd ngrok-docs

Next, run:

direnv allow

This will install nvm (if not already installed) as well as set the correct node and pnpm versions for you.

Once you have the pre-requisites installed, local development happens by running:

pnpm run start

Our docs mostly use markdown and MDX, you can make yourself familiar with docusaurus documentation for more significant features / changes.

Building ngrok-docs

To ensure your changes work before submitting a pr, please run the following before submission:

cd ngrok-docs
pnpm run fmt
pnpm run test
pnpm run typecheck
pnpm run build

Testing

We use Vitest for testing. To run the tests, use:

pnpm run test

To run tests in watch mode during development:

pnpm run test:watch

Looking for support?

For bug reports, feature request, questions and community support please ooen an issue or discussion in our ngrok Community. To report a problem with our documentation, please open a new Github issue.

License

ngrok59/ngrok-docs

ErrorLooks like something went wrong!

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages