Engine/docs/README.md

21 lines
501 B
Markdown
Raw Normal View History

2024-06-16 15:52:33 +02:00
# sos!engine documentation
The StarOpenSource Project uses [Docusaurus](https://docusaurus.io) for generating sos!engine's documentation.
# Commands
```bash
# Installs all required dependencies
make install-deps
# Starts a development server with support for hot reloading
make test
# Build the documentation to 'out/'
make build
# Remove 'out/' directory as well as some of Docusaurus' files
make clean
# If you want to remove node_modules and other pnpm stuff execute this
make clean-extra
```