Skip to content

Commit 42d8fa0

Browse files
authored
docs: share build.sh script in MkDocs contributing guide (#263)
1 parent b80df93 commit 42d8fa0

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

docs/user-guide/README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,14 @@ Instead, open the site using one of the following URLs:
3636
* `http://localhost:8000/docker-papermc-server/`
3737
* `http://127.0.0.1:8000/docker-papermc-server/`
3838

39-
## 🛠 Wrapper Script
39+
### 🛠️ Building the Site
4040

41-
To run `mkdocs` commands manually, use the `mkdocs.sh` wrapper script. For example:
41+
If you want to generate the site files without starting the local development server, you can run:
4242

4343
```bash
44-
./mkdocs.sh build
44+
./build.sh
4545
```
4646

47-
That said, unless you have a specific reason, it’s recommended to use `localdev.sh`, as it handles everything needed for local development.
48-
4947
## ➕ Adding Dependencies
5048

5149
### 🐍 Python Packages

0 commit comments

Comments
 (0)