Skip to content

Commit 3ed6672

Browse files
frankpaganfrankpagan
committed
docs: CoCreate-hosting package to publish docs
1 parent 67fd778 commit 3ed6672

5 files changed

Lines changed: 132 additions & 227 deletions

File tree

‎CoCreate.config.js‎

Lines changed: 41 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -7,53 +7,52 @@ module.exports = {
77
},
88

99
sources: [
10-
{
11-
path: "./docs/index.html",
12-
collection: "website-pages",
13-
document_id: "5fcd7624a1e91e001085a053",
14-
key: "html",
15-
data:{
16-
name: "CoCreateJS Doc",
17-
}
18-
},
1910
// {
20-
// path: "./docs/index.html",
11+
// entry: "./docs/index.html",
12+
// collection: "website-pages",
13+
// document_id: "5fcd7624a1e91e001085a053",
14+
// key: "src",
15+
// data:{
16+
// name: "CoCreateJS Doc",
17+
// domains: ["cocreate.app", "server.cocreate.app", "ws.cocreate.app"],
18+
// path: "/docs",
19+
// }
20+
// },
21+
// {
22+
// entry: "./docs/introduction.html",
23+
// collection: "files",
24+
// document_id: "60888216117c640e7596303f",
25+
// key: "src",
26+
// data:{
27+
// name: "CoCreateJS Intro Doc",
28+
// domains: ["cocreate.app", "server.cocreate.app", "ws.cocreate.app"],
29+
// path: "/docs/intro",
30+
// }
31+
// },
32+
// {
33+
// entry: "./docs/elements.html",
2134
// collection: "files",
22-
// document_id: "602726f95e697f4f26a98a57",
35+
// document_id: "6084db6968177d4c2f556fd7",
2336
// key: "html",
2437
// data:{
25-
// name: "CoCreateJS Doc",
38+
// name: "CoCreateJS Elements Doc",
39+
// domains: ["cocreate.app", "server.cocreate.app", "ws.cocreate.app"],
40+
// path: "/docs/elements",
41+
// }
42+
// },
43+
// {
44+
// entry: "./docs/CoCreateJS-objects.html",
45+
// collection: "files",
46+
// document_id: "60888216117c640e75963040",
47+
// key: "src",
48+
// data:{
49+
// name: "CoCreateJS Objects Doc",
50+
// domains: ["cocreate.app", "server.cocreate.app", "ws.cocreate.app"],
51+
// path: "/docs/cocreatejs-objects",
2652
// }
2753
// },
2854
{
29-
path: "./docs/introduction.html",
30-
collection: "files",
31-
document_id: "60888216117c640e7596303f",
32-
key: "html",
33-
data:{
34-
name: "CoCreateJS Intro Doc",
35-
}
36-
},
37-
{
38-
path: "./docs/elements.html",
39-
collection: "files",
40-
document_id: "6084db6968177d4c2f556fd7",
41-
key: "html",
42-
data:{
43-
name: "CoCreateJS Elements Doc",
44-
}
45-
},
46-
{
47-
path: "./docs/CoCreateJS-objects.html",
48-
collection: "files",
49-
document_id: "60888216117c640e75963040",
50-
key: "html",
51-
data:{
52-
name: "CoCreateJS Objects Doc",
53-
}
54-
},
55-
{
56-
path: "./docs/menu.html",
55+
entry: "./docs/menu.html",
5756
collection: "components",
5857
document_id: "603717b07de7fb350ae9fec8",
5958
key: "html",
@@ -62,71 +61,17 @@ module.exports = {
6261
}
6362
},
6463
{
65-
path: "./docs/navbar.html",
64+
entry: "./docs/navbar.html",
6665
collection: "components",
6766
document_id: "60395ef42b3ac232657040fd",
6867
key: "html",
6968
data:{
7069
name: "CoCreateJS Doc Navbar",
7170
}
7271
},
73-
// {
74-
// path: "./docs/elements.html",
75-
// collection: "files",
76-
// document_id: "6084db6968177d4c2f556fd7",
77-
// key: "html",
78-
// data:{
79-
// name: "CoCreateJS Elements Doc",
80-
// }
81-
// },
8272
],
8373

84-
crud: [{
85-
collection: "routes",
86-
document_id: "602726f95e697f4f26a98a56",
87-
data:{
88-
collection: "files",
89-
document_id: "602726f95e697f4f26a98a57",
90-
name: "html",
91-
domains: ["cocreate.app", "server.cocreate.app", "ws.cocreate.app"],
92-
route: "/docs",
93-
}
94-
},
95-
{
96-
collection: "routes",
97-
document_id: "60888216117c640e7596303d",
98-
data:{
99-
collection: "files",
100-
document_id: "60888216117c640e7596303f",
101-
name: "html",
102-
domains: ["cocreate.app", "server.cocreate.app", "ws.cocreate.app"],
103-
route: "/docs/intro",
104-
}
105-
},
106-
{
107-
collection: "routes",
108-
document_id: "6084db6968177d4c2f556fd6",
109-
data:{
110-
collection: "files",
111-
document_id: "6084db6968177d4c2f556fd7",
112-
name: "html",
113-
domains: ["cocreate.app", "server.cocreate.app", "ws.cocreate.app"],
114-
route: "/docs/elements",
115-
}
116-
},
117-
{
118-
collection: "routes",
119-
document_id: "60888216117c640e7596303e",
120-
data:{
121-
collection: "files",
122-
document_id: "60888216117c640e75963040",
123-
name: "html",
124-
domains: ["cocreate.app", "server.cocreate.app", "ws.cocreate.app"],
125-
route: "/docs/cocreatejs-objects",
126-
}
127-
},
128-
],
129-
74+
13075
extract: {
13176
directory: "./src/",
13277
extensions: [

‎docs/elements.html‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -404,19 +404,19 @@ <h2 class="border-bottom:1px_solid_lightgrey padding:5px_0px">CRUD Attributes</h
404404
<ul class="list-style-type:none position:sticky top:0 height:100vh overflow:auto">
405405
<li class="padding:15px_0px border-bottom:1px_solid_lightgrey">
406406
<h4><span>data-realtime</span> <span class="cocreate-badge success">boolean</span> <span class="cocreate-badge warning">optional</span></h4>
407-
<p>Save data onChange. If attribute is empty or not used Default's to true.</p>
407+
<p>Save data onChange, if false a btn required to save. If attribute is empty or not used Default's to true.</p>
408408
</li>
409409
<li class="padding:15px_0px border-bottom:1px_solid_lightgrey">
410410
<h4><span>data-collection</span> <span class="cocreate-badge success">string</span> <span class="cocreate-badge danger">required</span></h4>
411-
<p>Save data onChange. Default's to true if not appllied.</p>
411+
<p>Defines a collection name where your documents will be stored. sql equivalent is a table.</p>
412412
</li>
413413
<li class="padding:15px_0px border-bottom:1px_solid_lightgrey">
414414
<h4><span>data-document_id</span> <span class="cocreate-badge success">string</span> <span class="cocreate-badge danger">required</span></h4>
415-
<p>Save data onChange. Default's to true if not appllied.</p>
415+
<p>Defines the document by id where your data will be stored. if left empty one will be generated. sql equvalient is a row</p>
416416
</li>
417417
<li class="padding:15px_0px border-bottom:1px_solid_lightgrey">
418418
<h4><span>name</span> <span class="cocreate-badge success">string</span> <span class="cocreate-badge danger">required</span></h4>
419-
<p>Save data onChange. If attribute is empty or not used Default's to true.</p>
419+
<p>Defines the name in the document containing the value. sql equvalient is a column</p>
420420
</li>
421421
<li class="padding:15px_0px border-bottom:1px_solid_lightgrey">
422422
<h4><span>data-read_value</span> <span class="cocreate-badge success">boolean</span> <span class="cocreate-badge warning">optional</span></h4>
@@ -428,27 +428,27 @@ <h4><span>data-save_value</span> <span class="cocreate-badge success">boolean</s
428428
</li>
429429
<li class="padding:15px_0px border-bottom:1px_solid_lightgrey">
430430
<h4><span>data-cursors</span> <span class="cocreate-badge success">boolean</span> <span class="cocreate-badge warning">optional</span></h4>
431-
<p>Save data onChange/submitBtn. If attribute is empty or not used Default's to true.</p>
431+
<p>Show collaborators cursor positions. If attribute is empty or not used Default's to true.</p>
432432
</li>
433433
<li class="padding:15px_0px border-bottom:1px_solid_lightgrey">
434434
<h4><span>contenteditable</span> <span class="cocreate-badge success">boolean</span> <span class="cocreate-badge warning">optional</span></h4>
435-
<p>htmltags can be editable</p>
435+
<p>htmltags can be editable and display will collaborators cursors.</p>
436436
</li>
437437
<li class="padding:15px_0px border-bottom:1px_solid_lightgrey">
438438
<h4><span>data-namespace</span> <span class="cocreate-badge success">string</span> <span class="cocreate-badge warning">optional</span></h4>
439-
<p>room-attribute</p>
439+
<p>Define a unique namespace where messages and changes are sent and received</p>
440440
</li>
441441
<li class="padding:15px_0px border-bottom:1px_solid_lightgrey">
442442
<h4><span>data-room</span> <span class="cocreate-badge success">string</span> <span class="cocreate-badge warning">optional</span></h4>
443-
<p>room-attribute</p>
443+
<p>Define a unique room where messages and changes are sent and received</p>
444444
</li>
445445
<li class="padding:15px_0px border-bottom:1px_solid_lightgrey">
446446
<h4><span>data-broadcast</span> <span class="cocreate-badge success">string</span> <span class="cocreate-badge warning">optional</span></h4>
447-
<p>room-attribute</p>
447+
<p>Broadcast messages and changes to other collaborators in the same namespace and room. If attribute is empty or not used default's to true.</p>
448448
</li>
449449
<li class="padding:15px_0px border-bottom:1px_solid_lightgrey">
450450
<h4><span>data-broadcast_sender</span> <span class="cocreate-badge success">string</span> <span class="cocreate-badge warning">optional</span></h4>
451-
<p>room-attribute</p>
451+
<p>Broadcast messages and changes to self. If attribute is empty or not used default's to false.</p>
452452
</li>
453453

454454
</ul>

0 commit comments

Comments
 (0)