Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/yjs/yjs-website

Last synced: 4 days ago
JSON representation

Host: GitHub
URL: https://github.com/yjs/yjs-website
Owner: yjs
Created: 2022-08-31T16:30:03.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2022-10-20T09:03:27.000Z (about 2 years ago)
Last Synced: 2024-04-13T07:08:43.469Z (7 months ago)
Language: JavaScript
Size: 2.83 MB
Stars: 2
Watchers: 2
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Yjs Documentation

[![Netlify Status](https://api.netlify.com/api/v1/badges/6e5277b2-b8d2-4c37-847f-bc4f26d61d9f/deploy-status)](https://app.netlify.com/sites/beta-yjs/deploys)

This repository implements a friendly documentation website for Yjs full of
examples and live previews. **PRs are welcome!**

It is built using [docusaurus](https://docusaurus.io). If you want to make modifications, fork this repository, clone it and start the development server. The articles are written in `mdx` (markdown + react components) and are located in the `docs` directory.

```sh
# 1. Fork this repository. See the top-right "fork button" in GitHub.
# 2. Clone your fork
git clone https://github.com/{your-username}/yjs-website.git
# 3. Install dependencies
npm i
# 4. Start development server
npm start
```