remotestorage.io

This is the remoteStorage website, running on remotestorage.io.

Development

The website is built using VitePress. It includes the remoteStorage.js documentation via a Git submodule.

Setup

With Git and node.js installed, and an SSH key associated with your GitHub account...

Clone this repo:

git clone [email protected]:remotestorage/website.git
cd website

Initialize and fetch the rs.js submodule:

git submodule update --init

Install the dependencies:

npm install

Running

Run the local dev server, which automatically updates the local preview site whenever documents are saved:

npm run docs:dev

Deployment

The master branch is automatically built and deployed to GitHub Pages.