Skip to content

Latest commit

 

History

History
78 lines (51 loc) · 2.47 KB

README.md

File metadata and controls

78 lines (51 loc) · 2.47 KB
Raw

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.

Prerequisites required:

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

Prefer to install and manage the tooling yourself?
  1. Install nvm or your node version manager of choice.
  2. Ensure that node 20 is installed. With nvm, run nvm install.
  3. Enable pnpm with corepack: corepack enable pnpm
  4. Install pnpm with corepack: corepack install
  5. 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 build

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.