| .. | ||
| docs | ||
| src/css | ||
| static | ||
| .gdignore | ||
| .gitignore | ||
| babel.config.js | ||
| docusaurus.config.ts | ||
| Makefile | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| sidebars.ts | ||
| tsconfig.json | ||
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