Engine/docs
JeremyStarTM e9e57a732a
All checks were successful
build-and-test / build (push) Successful in 2m11s
build-and-test / test (push) Successful in 2m7s
build-and-test / generate-javadoc (push) Successful in 2m10s
Add API documentation links for v1-alpha4
2024-09-05 02:01:13 +02:00
..
docs Add API documentation links for v1-alpha4 2024-09-05 02:01:13 +02:00
src/css Add documentation 2024-06-16 15:52:33 +02:00
static Add documentation 2024-06-16 15:52:33 +02:00
.gitignore Add documentation 2024-06-16 15:52:33 +02:00
babel.config.js Add documentation 2024-06-16 15:52:33 +02:00
docusaurus.config.ts Fix Java, Groovy and Kotlin code highlighting 2024-07-11 22:38:56 +02:00
Makefile Add update-deps task to docs/Makefile 2024-07-24 02:02:55 +02:00
package-lock.json Add documentation 2024-06-16 15:52:33 +02:00
package.json Update docusaurus 2024-08-20 20:54:46 +02:00
README.md Add documentation 2024-06-16 15:52:33 +02:00
sidebars.ts Add documentation 2024-06-16 15:52:33 +02:00
tsconfig.json Add documentation 2024-06-16 15:52:33 +02:00

sos!engine documentation

The StarOpenSource Project uses Docusaurus for generating sos!engine's documentation.

Commands

# 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