Merge pull request #88 from danielh-official/add-instructions-for-torchlight

Author: PeteBishwhip

.env.example

@@ -56,3 +56,5 @@ VITE_PUSHER_HOST="${PUSHER_HOST}"
 VITE_PUSHER_PORT="${PUSHER_PORT}"
 VITE_PUSHER_SCHEME="${PUSHER_SCHEME}"
 VITE_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
+
+TORCHLIGHT_TOKEN=

CONTRIBUTING.md

@@ -0,0 +1,22 @@
+Thank you for contributing!
+
+## Getting Started
+
+Be sure to fork and clone the repo: `gh repo clone NativePHP/nativephp.com`
+
+Make a branch for what change you want to contribute and open a pull request to the upstream main branch.
+
+## Torchlight
+
+The documentation uses [torchlight.dev](torchlight.dev) for syntax highlighting.
+
+Without a token, you will run into an error on pages like "/docs/desktop/1/getting-started/introduction".
+
+To get set up:
+
+1. Create an account and then make a new API token [here](https://torchlight.dev/account/api-tokens).
+2. Then set the API token in the .env.
+
+```
+TORCHLIGHT_TOKEN=<token>
+```

README.md

@@ -6,6 +6,8 @@ This repo contains the content of the nativephp.com website.
 
 We welcome any contributions to improve the documentation. Please feel free to open a PR.
 
+Also, be sure to read our [contributing guidelines](CONTRIBUTING.md) for help getting set up.
+
 ## Issues
 
 Please raise any issues on the [NativePHP/laravel](https://github.com/NativePHP/laravel/issues) repo.