2024-04-03 00:09:47 +02:00
|
|
|
# Documentation for ShulkerScript
|
2024-06-24 12:06:42 +02:00
|
|
|
|
2024-04-03 00:09:47 +02:00
|
|
|
This is the documentation for ShulkerScript. It is a work in progress and will be updated as the language evolves.
|
|
|
|
|
|
|
|
|
|
## Getting Started
|
2024-06-24 12:06:42 +02:00
|
|
|
|
2024-04-03 00:09:47 +02:00
|
|
|
This documentation is created using Astro and Starlight. To get started, you need to install the dependencies and start the development server.
|
|
|
|
|
|
2024-06-24 12:06:42 +02:00
|
|
|
## Requirements
|
|
|
|
|
|
|
|
|
|
Required tools:
|
|
|
|
|
|
|
|
|
|
- [Node.js](https://nodejs.org)
|
|
|
|
|
- [pnpm](https://pnpm.io)
|
|
|
|
|
- [Cargo](https://rustup.rs)
|
|
|
|
|
- with `wasm32-unknown-unknown` target installed
|
|
|
|
|
- [`wasm-bindgen-cli`](https://crates.io/crates/wasm-bindgen-cli)
|
|
|
|
|
|
2024-04-03 00:09:47 +02:00
|
|
|
## 🧞 Commands
|
|
|
|
|
|
|
|
|
|
All commands are run from the root of the project, from a terminal:
|
|
|
|
|
|
2024-06-24 12:06:42 +02:00
|
|
|
| Command | Action |
|
|
|
|
|
| :------------------------- | :----------------------------------------------- |
|
2024-06-23 20:28:12 +02:00
|
|
|
| `pnpm install` | Installs dependencies |
|
|
|
|
|
| `pnpm run dev` | Starts local dev server at `localhost:4321` |
|
|
|
|
|
| `pnpm run build` | Build your production site to `./dist/` |
|
2024-06-24 12:06:42 +02:00
|
|
|
| `pnpm run build-wasm` | Build your wasm modules |
|
2024-06-23 20:28:12 +02:00
|
|
|
| `pnpm run preview` | Preview your build locally, before deploying |
|
|
|
|
|
| `pnpm run astro ...` | Run CLI commands like `astro add`, `astro check` |
|
2024-06-24 12:06:42 +02:00
|
|
|
| `pnpm run astro -- --help` | Get help using the Astro CLI |
|
