Skip to content

Commit 1bf9590

Browse files
Update index.md
1 parent dcbcf46 commit 1bf9590

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

docs/index.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,41 @@
1-
coming soon.
1+
# _just
2+
3+
_just - is a postprocessor that allows you to modify generated Next.js pages before publishing them to GitHub. <br>
4+
<small>Made for lazy devs.</small>
5+
6+
---------
7+
# WHERE I CAN USE _JUST
8+
9+
You can use **_just** only in your Next.js website on GitHub Pages.
10+
11+
---------
12+
# HOW TO USE
13+
14+
1. Create "`_just`" directory in root directory of your GitHub repository.
15+
2. Create "`js`", "`style`", "`dangerously-insert-files`" sub-directories in "`_just`" directory.
16+
3. Create "`404.html`" file that you can customize as you want and insert it in "`_just`" directory.
17+
4. You can add as many as you want JavaScript files in "`js`" sub-directory, these files will be applied to **all** pages on your website.
18+
5. You can add as many as you want CSS files in "`style`" sub-directory, these files will be applied to **all** pages on your website.
19+
6. If you want, you also can add **any** files in "`dangerously-insert-files`" sub-directory, these files will be available at `(PATH TO YOUR WEBSITE)/(FILE NAME)`.
20+
> [!WARNING]
21+
> INSERTING FILES DIRECTLY IN GENERATED NEXT.JS WEBSITE MAY CAUSE ERRORS.
22+
7. Now in your "`.github/workflows/nextjs.yml`" file insert this after "`Build with Next.js`":
23+
```yml
24+
- name: _just
25+
uses: JustDeveloper1/[email protected]
26+
```
27+
8. Change "`Upload artifact`" step's path to "`deploy`". It should look like:
28+
```yml
29+
- name: Upload artifact
30+
uses: actions/upload-pages-artifact@v3
31+
with:
32+
path: deploy
33+
```
34+
35+
---------
36+
# BEST EXAMPLES
37+
38+
If you want to take a look at websites and services that using _just, here is the best of them:
39+
> [Encoder.js](https://github.com/JustStudio7/Encoder) by [JustStudio.](https://github.com/JustStudio7)
40+
41+
Think you are better? [Open an issue](https://github.com/JustDeveloper1/_just/issues/new) with requesting your project to be added in this list!

0 commit comments

Comments
 (0)