This repository contains the documentation for ror-player.
To build the documentation, follow these steps:
- Run
npm install - Run
npm run build - Find the build in the
dist/directory.
When making changes, run npm run dev-server to start a temporary HTTP server that automatically rebuilds the documentation when changes are made. Run npm run check to make sure that there are no dead links in the documentation.
To host the documentation, either host the static build in dist/ or run the docker image beatboxjs/ror-player-docs using docker run beatboxjs/ror-player-docs. It exposes a simple HTTP server on port 80.