Reactodia Docs

Reactodia documentation portal is built using Docusaurus, a modern static website generator.

Installation

$ npm i

Local Development

To build the docs on local machine, the project expects to have Reactodia Workspace repository to be checked out at ../reactodia-workspace (i.e. in reactodia-workspace directory at the parent directory for the docs itself). This is necessary to generate API Reference for the library using docusaurus-plugin-typedoc.

$ npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Run the following command to test the built assets locally:

$ npm run serve

Deployment

The docs are deployed to the GitHub Pages using Deploy to GitHub pages action workflow.