Skip to content

Latest commit

 

History

History
39 lines (25 loc) · 977 Bytes

README.md

File metadata and controls

39 lines (25 loc) · 977 Bytes
Raw

MemoryViz Documentation Website

This website is built using Docusaurus, a modern static website generator.

The commands described in this README assume your current working directory is memory-viz/docs. You can instead run them in the root project directory by adding the argument --workspace=docs.

Local Development

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

Deployment

Using SSH:

$ USE_SSH=true npm run deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> npm run 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.