ngrok-docs
No description available
Ask AI about ngrok-docs
Powered by Claude · Grounded in docs
I know everything about ngrok-docs. Ask me about installation, configuration, usage, or troubleshooting.
0/500
Reviews
Documentation
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?
- Install nvm or your node version manager of choice.
- Ensure that
node 20is installed. Withnvm, runnvm install. - Enable
pnpmwithcorepack:corepack enable pnpm - Install
pnpmwithcorepack: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 build
Looking for support?
For questions and support on contributing please join our Slack community, channel #support.
To file an issue within our doc, use our github issues
