File tree Expand file tree Collapse file tree 1 file changed +18
-4
lines changed Expand file tree Collapse file tree 1 file changed +18
-4
lines changed Original file line number Diff line number Diff line change 1
1
* Sharedb-ace
2
- [[https://badge.fury.io/js/sharedb-ace.svg]]
2
+ [[https://badge.fury.io/js/@sourceacademy%2Fsharedb-ace.svg]]
3
+
4
+ This is a fork of the [[https://github.com/jethrokuan/sharedb-ace][original sharedb-ace repository]].
3
5
4
6
Sharedb-ace provides two-way bindings between [[https://github.com/share/sharedb][ShareDB]] and [[http://ace.c9.io/][Ace Editor]].
5
7
6
8
** Installation
7
9
Using npm:
8
10
9
11
#+BEGIN_SRC sh
10
- npm install sharedb-ace
12
+ npm install @sourceacademy/ sharedb-ace
11
13
#+END_SRC
12
14
13
15
Using pre-compiled js from unpkg CDN:
@@ -17,7 +19,6 @@ Using pre-compiled js from unpkg CDN:
17
19
#+END_SRC
18
20
19
21
** Documentation
20
- Please see [[http://www.jethrokuan.com/sharedb-ace/][here]] for internals documentation.
21
22
22
23
*** Single Ace-editor Instance
23
24
Setup the ShareDB document as a string:
@@ -52,9 +53,22 @@ git clone https://github.com/jethrokuan/sharedb-ace.git
52
53
#+END_SRC
53
54
54
55
#+BEGIN_SRC sh
55
- cd sharedb-ace && npm install
56
+ cd sharedb-ace && yarn install
57
+ #+END_SRC
58
+
59
+ To test the package locally, run the following on this sharedb-ace repository:
60
+ #+BEGIN_SRC sh
61
+ yarn build
62
+ yarn link
56
63
#+END_SRC
57
64
65
+ Then, run the following on the frontend repository:
66
+ #+BEGIN_SRC sh
67
+ yarn link @sourceacademy/sharedb-ace
68
+ #+END_SRC
69
+
70
+ Now, whenever you want to update the ShareDB Ace binding, simply run `yarn build`.
71
+
58
72
*** Generating JS Docs
59
73
We generate javascript documentation using inline documentation.
60
74
You can’t perform that action at this time.
0 commit comments