CORE/docs
2024-05-15 01:58:52 +02:00
..
docs Add awaiting required note 2024-05-15 01:58:52 +02:00
src/css Replace index page with redirect 2024-05-10 15:33:29 +02:00
static why this here 2024-03-15 13:09:28 +01:00
.gdignore Move & update .gdignore 2024-03-03 19:16:36 +01:00
.gitignore Uncringe the project 2024-02-04 21:36:30 +01:00
babel.config.js Uncringe the project 2024-02-04 21:36:30 +01:00
docusaurus.config.ts Update docs README.md and config 2024-05-11 23:27:35 +02:00
Makefile Uncringe the project 2024-02-04 21:36:30 +01:00
package-lock.json Uncringe the project 2024-02-04 21:36:30 +01:00
package.json Update docusaurus 2024-05-05 15:01:12 +02:00
README.md Update docs README.md and config 2024-05-11 23:27:35 +02:00
sidebars.ts Uncringe the project 2024-02-04 21:36:30 +01:00
tsconfig.json Uncringe the project 2024-02-04 21:36:30 +01:00

CORE Framework documentation

The CORE Framework documentation uses Docusaurus.

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