Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 1.11 KB

README.md

File metadata and controls

48 lines (31 loc) · 1.11 KB
Raw

Reactodia Docs

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

Installation

$ npm i

Local Development

$ 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.

To see embedded interactive examples at /interactive-examples create a symbolic link (or junction point on Windows) into compiled example bundles directory as static/examples.

For example, on Windows using cmd:

reactodia.github.io\static> mklink /j examples ../../reactodia-workspace/dist/examples

Build

$ npm run build

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

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.