Go to file
Moritz Hölting fe286a3609 change from git to crates.io dependency, add vs code extension 2024-10-01 12:12:38 +02:00
.github/workflows Merge branch 'feature/playground' 2024-10-01 02:34:37 +02:00
.vscode First version of the docs 2024-04-03 00:09:47 +02:00
public First version of the docs 2024-04-03 00:09:47 +02:00
src change from git to crates.io dependency, add vs code extension 2024-10-01 12:12:38 +02:00
.gitignore add build-wasm pnpm command 2024-06-24 12:06:42 +02:00
README.md Merge branch 'feature/playground' 2024-10-01 02:34:37 +02:00
astro.config.mjs Merge branch 'feature/playground' 2024-10-01 02:34:37 +02:00
package.json Merge branch 'feature/playground' 2024-10-01 02:34:37 +02:00
pnpm-lock.yaml Merge branch 'feature/playground' 2024-10-01 02:34:37 +02:00
tsconfig.json add basic code editor for playground 2024-06-20 15:43:14 +02:00

README.md

Documentation for Shulkerscript

This is the documentation for Shulkerscript. It is a work in progress and will be updated as the language evolves.

Getting Started

This documentation is created using Astro and Starlight. To get started, you need to install the dependencies and start the development server.

Requirements

Required tools:

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command Action
pnpm install Installs dependencies
pnpm run dev Starts local dev server at localhost:4321
pnpm run build Build your production site to ./dist/
pnpm run build-wasm Build your wasm modules
pnpm run preview Preview your build locally, before deploying
pnpm run astro ... Run CLI commands like astro add, astro check
pnpm run astro -- --help Get help using the Astro CLI