- The
src
directory contains the files used to generate the site. - Because the site is "deployed" to Github Pages, the build outputs static files in the
docs
directory.
- NodeJS (v16 or greater should be fine) & NPM
- Bash (the NPM scripts assume you can use Bash)
cd <REPO_ROOT>/src
npm install
cd <REPO_ROOT>/src
npm run build
See the package.json
file for more details.
Because if we allow Github Pages' default Build with Jekyll
step to run, folders with names beginning with underscores are not served (EX: _next/
). See this issue for more details.
cd <REPO_ROOT>/src
npm run dev
See the package.json
file for more details.