Skip to content

automerge/automerge.github.io

Repository files navigation

Automerge docs

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

Installation

$ yarn

The source for the latest release of the javascript package @automerge/automerge is included as a git submodule, so you need to update submodules.

git submodule update

Local Development

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

$ yarn build

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

Deployment

$ GIT_USER=<Your GitHub username> USE_SSH=true 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.