core2lord/ngrok-docs

ngrok's official documentation

ngrok docs

This is the source for the ngrok docs; feel free to suggest changes and improvements to our documentation!

Contributing

We welcome and celebrate contributions! See our Contribution Guidelines for detailed instructions on how to help improve the ngrok docs.

Setup ngrok docs

ngrok is built using Docusaurus 2.

To setup our docs in your host, simply

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

While our Docusaurus uses mostly markdowns, you can make yourself familiar with its documentation for more significant changes.

Building ngrok-docs

To ensure your changes will works — i.e. its not missing links, you can run a local build:

cd ngrok-docs
yarn 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