Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/remotestorage/website
The official remoteStorage website
https://github.com/remotestorage/website
Last synced: 2 months ago
JSON representation
The official remoteStorage website
- Host: GitHub
- URL: https://github.com/remotestorage/website
- Owner: remotestorage
- Created: 2015-09-15T16:11:13.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-08-08T16:03:22.000Z (5 months ago)
- Last Synced: 2024-08-09T18:36:04.875Z (5 months ago)
- Language: CSS
- Homepage: https://remotestorage.io
- Size: 13.9 MB
- Stars: 16
- Watchers: 17
- Forks: 11
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-starred - remotestorage/website - The official remoteStorage website (others)
README
# remotestorage.io
This is the remoteStorage website, running on
[remotestorage.io](https://remotestorage.io).
## Development
The website is built using [VitePress](https://vitepress.dev/). It includes the
[remoteStorage.js](https://github.com/remotestorage/remotestorage.js)
documentation via a Git submodule.
### Setup
With [Git](https://git-scm.com) and [node.js](https://nodejs.org) installed,
and an SSH key associated with your GitHub account...
Clone this repo:
```sh
git clone [email protected]:remotestorage/website.git
cd website
```
Initialize and fetch the rs.js submodule:
```sh
git submodule update --init
```
Install the dependencies:
```sh
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.