SideStore Documentation

This is the official GitHub repository for SideStore's documentation hosted at https://wiki.sidestore.io.

This project is licensed under the GNU Affero General Public License.

Installation

yarn

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

The documentation uses GitHub Pages as hosting. To deploy to GitHub Pages, run one of the following commands based on how you cloned this repo.

Using SSH:

USE_SSH=true yarn deploy

Not using SSH:

GIT_USER=<Your GitHub username> yarn deploy

Status