The StarOpenSource documentation
Go to file
JeremyStar™ 090abdf993 Initial commit 2024-03-02 18:26:21 +01:00
docs Initial commit 2024-03-02 18:26:21 +01:00
src Initial commit 2024-03-02 18:26:21 +01:00
static Initial commit 2024-03-02 18:26:21 +01:00
.gitignore Initial commit 2024-03-02 18:26:21 +01:00
LICENSE Initial commit 2024-03-02 18:26:21 +01:00
Makefile Initial commit 2024-03-02 18:26:21 +01:00
README.md Initial commit 2024-03-02 18:26:21 +01:00
babel.config.js Initial commit 2024-03-02 18:26:21 +01:00
docusaurus.config.ts Initial commit 2024-03-02 18:26:21 +01:00
package-lock.json Initial commit 2024-03-02 18:26:21 +01:00
package.json Initial commit 2024-03-02 18:26:21 +01:00
sidebars.ts Initial commit 2024-03-02 18:26:21 +01:00
tsconfig.json Initial commit 2024-03-02 18:26:21 +01:00

README.md

sos!docs

Here you can find the StarOpenSource documentation. Click here to visit the built documentation.

Commands

We use make.

Installing dependencies

$ make install-deps

Development web server

This will start a development server that supports hot reloading.

$ make test

Building the documentation

This will output the built documentation to out/. Simply point a web server to it and you're done.

$ make build

Cleaning the directory

This will remove the out/ directory containing the built website aswell as Docusaurus files.

$ make clean

More cleaning

This will remove the node_modules/ and pnpm-lock.yaml directory aswell.

$ make clean-extra