Skip to content

Commit 1c8c1a5

Browse files
Add a CONTRIBUTING.md and move Torchlight instructions
1 parent 4724574 commit 1c8c1a5

File tree

2 files changed

+24
-11
lines changed

2 files changed

+24
-11
lines changed

CONTRIBUTING.md

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

README.md

+2-11
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,8 @@ This repo contains the content of the nativephp.com website.
66

77
We welcome any contributions to improve the documentation. Please feel free to open a PR.
88

9+
Also, be sure to read our [contributing guidelines](CONTRIBUTING.md) for help getting set up.
10+
911
## Issues
1012

1113
Please raise any issues on the [NativePHP/laravel](https://github.com/NativePHP/laravel/issues) repo.
12-
13-
## Torchlight
14-
15-
The documentation uses [torchlight.dev](torchlight.dev) to generate a token.
16-
17-
1. Create an account and then make a new API token [here](https://torchlight.dev/account/api-tokens).
18-
2. Then set the API token in the .env.
19-
20-
```
21-
TORCHLIGHT_TOKEN=<token>
22-
```

0 commit comments

Comments
 (0)