Skip to content

Commit

Permalink
add Readme to every directory and clean up project. fixes #44 & fixes #…
Browse files Browse the repository at this point in the history
  • Loading branch information
dmonad committed Dec 3, 2020
1 parent 41f61c8 commit 0539e95
Show file tree
Hide file tree
Showing 41 changed files with 841 additions and 2,036 deletions.
4 changes: 2 additions & 2 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
tasks:
- init: npm install
command: npm run start
- init: cd demo-server && npm i && npm run dist-all
command: cd demo-server && npm run start
ports:
- port: 8080
onOpen: open-preview
2 changes: 1 addition & 1 deletion Procfile
Original file line number Diff line number Diff line change
@@ -1 +1 @@
web: npm start
web: cd demo-server && npm i && npm run dist-all && npm start
27 changes: 10 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,22 @@

# Yjs Demos [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/yjs/yjs-demos)


> A starting point for your own ideas - PRs welcome
* Shared Editing using the [ProseMirror](http://prosemirror.net/) editor - [Live
Demo](https://demos.yjs.dev/prosemirror/prosemirror.html)
* Shared Editing using the [ProseMirror](http://prosemirror.net/) editor - [Open Directory](./prosemirror/)
* Shared Editing using the [ProseMirror](http://prosemirror.net/) editor with
versioning support - [Live
Demo](https://demos.yjs.dev/prosemirror-versions/prosemirror-versions.html)
* Shared Editing using the [Dat Protocol](https://dat.foundation/) - [Live
Demo](https://demos.yjs.dev/prosemirror-dat/prosemirror-dat.html)
* Shared Editing using the [Quill](https://quilljs.com/) editor - [Live
Demo](https://demos.yjs.dev/quill/quill.html)
versioning support - [Open Directory](./prosemirror-versions/)
* Shared Editing using the [Dat Protocol](https://dat.foundation/) - [Open Directory](./prosemirror-dat/)
* Shared Editing using the [Quill](https://quilljs.com/) editor - [Open Directory](./quill/)
* Shared Editing using the
[Atlassian Atlaskit](https://bitbucket.org/atlassian/atlaskit-mk-2/src/master/) editor -
[Live Demo](https://demos.yjs.dev/atlaskit/atlaskit.html)
[Atlassian Atlaskit](https://bitbucket.org/atlassian/atlaskit-mk-2/src/master/) editor - [Open Directory](./atlaskit/)
* Shared Editing using the [Monaco](https://microsoft.github.io/monaco-editor/)
editor - [Live Demo](https://demos.yjs.dev/monaco/monaco.html)
editor - [Open Directory](./monaco/)
* Shared Editing using the [CodeMirror](https://codemirror.net/)
editor - [Live Demo](https://demos.yjs.dev/codemirror/codemirror.html)
editor - [Open Directory](./codemirror/)
* Shared Editing using the [TipTap](https://tiptap.scrumpy.io/)
editor - [Live Demo](https://demos.yjs.dev/tiptap/dist/index.html)
editor - [Open Directory](./tiptap/)

## Get Started
## Getting Started

If you are new to Yjs and you just want to play around clone this repository and
use one of the demo directories that interests you the most.
Expand All @@ -36,7 +29,7 @@ npm start
```

The demos use a public [`y-websocket`](https://github.com/yjs/y-websocket)
instance for communication. Try using one of the other connectors or setting up
instance for communication. Try using one of the [other connection providers](https://docs.yjs.dev/ecosystem/connection-provider) or setting up
your own endpoint.

### (Un)License
Expand Down
16 changes: 16 additions & 0 deletions atlaskit/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Atlaskit Demo
> [y-prosemirror](https://docs.yjs.dev/ecosystem/editor-bindings/prosemirror) / [y-websocket](https://docs.yjs.dev/ecosystem/connection-provider/y-websocket) / [Live Demo](https://demos.yjs.dev/atlaskit/atlaskit.html)
This is a demo of an [Atlaskit](https://atlaskit.atlassian.com/) editor that was made collaborative with Yjs & y-prosemirror. Since Atlaskit is based on ProseMirror, we simply need to add y-prosemirror to the internal ProseMirror instance. Find out more about the prosemirror binding in our [Official Docs](https://docs.yjs.dev/ecosystem/editor-bindings/prosemirror).

We use the [y-websocket](https://docs.yjs.dev/ecosystem/connection-provider) provider to share document updates through a server. There are many more providers available for Yjs - try switching to another provider. [See docs](https://docs.yjs.dev/ecosystem/connection-provider).

Also you could try addingh offline persistence to this demo. Wouldn't it be cool if document updates are persisted in the browser, so you can load your application load faster? Try it out: https://docs.yjs.dev/getting-started/allowing-offline-editing

## Quick Start

```sh
npm i
npm start
# Project is running at http://localhost:8080/
```
2 changes: 1 addition & 1 deletion atlaskit/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 3 additions & 5 deletions atlaskit/package.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
{
"name": "prosemirror-atlaskit-demo",
"name": "yjs-atlaskit-demo",
"private": true,
"version": "0.0.0",
"description": "",
"main": "index.js",
"description": "Yjs ❤ Atlaskit",
"scripts": {
"dist": "webpack --mode=production",
"start": "webpack-dev-server --open-page atlaskit.html",
"postinstall": "npm run dist"
"start": "webpack-dev-server --open-page atlaskit.html"
},
"author": "Kevin Jahns <[email protected]>",
"license": "UNLICENSE",
Expand Down
16 changes: 16 additions & 0 deletions codemirror/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# ProseMirror Demo
> [y-codemirror](https://docs.yjs.dev/ecosystem/editor-bindings/codemirror) / [y-websocket](https://docs.yjs.dev/ecosystem/connection-provider/y-websocket) / [Live Demo](https://demos.yjs.dev/codemirror/codemirror.html)
This is a demo of a [CodeMirror 5](https://codemirror.net/) editor that was made collaborative with Yjs & y-codemirror.

We use the [y-websocket](https://docs.yjs.dev/ecosystem/connection-provider) provider to share document updates through a server. There are many more providers available for Yjs - try switching to another provider. [See docs](https://docs.yjs.dev/ecosystem/connection-provider).

Also you could try addingh offline persistence to this demo. Wouldn't it be cool if document updates are persisted in the browser, so you can load your application load faster? Try it out: https://docs.yjs.dev/getting-started/allowing-offline-editing

## Quick Start

```sh
npm i
npm start
# Project is running at http://localhost:8080/
```
2 changes: 1 addition & 1 deletion codemirror/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 3 additions & 5 deletions codemirror/package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
{
"name": "yjs-demos-codemirror",
"name": "yjs-codemirror-demo",
"version": "1.0.0",
"description": "Yjs CodeMirror editor binding demo",
"main": "index.js",
"description": "Yjs ❤ Atlaskit",
"scripts": {
"dist": "webpack --mode=production",
"start": "webpack-dev-server --open-page codemirror.html",
"postinstall": "npm run dist"
"start": "webpack-dev-server --open-page codemirror.html"
},
"author": "Kevin Jahns <[email protected]>",
"license": "UNLICENSE",
Expand Down
9 changes: 0 additions & 9 deletions config.js

This file was deleted.

Loading

0 comments on commit 0539e95

Please sign in to comment.