An open API service indexing awesome lists of open source software.

https://github.com/sipa-js/sipa-js.github.io

Website & documentation for Simpartic
https://github.com/sipa-js/sipa-js.github.io

framework single-page-app web webframework

Last synced: 5 months ago
JSON representation

Website & documentation for Simpartic

Awesome Lists containing this project

README

          

# Sipa documentation
[![License: LGPLv3](https://img.shields.io/badge/License-LGPLv3-fabd09.svg?style=plastic)](LICENSE)

This is the official repository for the Sipa documentation at:
https://sipa-js.github.io/

You can find the offical Sipa repository at:
https://github.com/sipa-js/sipa

## Info

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

### 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

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER= 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.