Skip to content

aljam3h/ngrok-docs

 
 

Repository files navigation

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.

Setup

ngrok is built using Docusaurus 2.

Prerequisites required:

Both of these can be obtained via nix-direnv, which will automatically configure your shell for you.

Once you have the pre-requisites installed run the following commands:

git clone https://github.com/ngrok/ngrok-docs.git
cd ngrok-docs
pnpm i && 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 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

About

ngrok's official documentation

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 60.8%
  • CSS 29.4%
  • TypeScript 8.1%
  • Nix 1.7%