Skip to content

Commit 2de81a0

Browse files
frankpaganfrankpagan
committed
Update documentation
1 parent 5964186 commit 2de81a0

File tree

2 files changed

+45
-25
lines changed

2 files changed

+45
-25
lines changed

‎docs/index.html‎

Lines changed: 44 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
66
<meta name="viewport" content="width=device-width, initial-scale=1">
7-
<title>CoCreate-boilerplate Documentation | CoCreateJS </title>
7+
<title>CoCreate-docs Documentation | CoCreateJS </title>
88
<link rel="icon" type="image/png" sizes="32x32" href="https://cocreate.app/images/favicon.ico">
99
<meta name="description" content="A simple HTML5 and pure javascript component. Easy configuration using data-attributes and highly styleable." />
1010
<meta name="keywords" content="helper classes, utility classes, css framework, css library, inline style classes" />
@@ -15,55 +15,75 @@
1515
</head>
1616

1717
<body>
18-
<div data-collection="" data-document_id="" name="" id="cocreate-boilerplate" class="padding:15px">
18+
<div data-collection="" data-document_id="" name="" id="cocreate-docs" class="padding:15px">
1919
<div class="display:flex flex-wrap:wrap justify-content:space-between">
2020
<div class="display:flex align-items:center">
21-
<h2>CoCreate-boilerplate</h2>
21+
<h2>CoCreate-docs</h2>
2222
</div>
23-
<div class="display:flex align-items:center font-size:20px social_share" data-height="600" data-width="500" data-media="https://via.placeholder.com/300/09f/fff.png">
24-
<a href="https://github.com/CoCreate-app/CoCreate-boilerplate" target="_blank" class="margin-right:15px"><i class="fab fa-github"></i></a>
25-
<a class="margin-right:15px share" data-network='twitter' title="Share on twitter"><i class="fab fa-twitter"></i></a>
26-
<a class="margin-right:15px share" data-network='facebook' title="Share on Facebook"><i class="fab fa-facebook"></i></a>
27-
<a class="margin-right:15px share" data-network='instagram' title="Share on instagram"><i class="fab fa-instagram"></i></a>
28-
<a class="margin-right:15px share" data-network='share' title="Share on share"><i class="fas fa-share-alt"></i></a>
23+
<div class="display:flex align-items:center font-size:20px" data-share_height="600" data-share_width="500" data-share_media="https://via.placeholder.com/300/09f/fff.png">
24+
<a href="https://github.com/CoCreate-app/CoCreate-docs" target="_blank" class="margin-right:15px"><i class="fab fa-github"></i></a>
25+
<a class="margin-right:15px" data-share_network='twitter' title="Share on twitter"><i class="fab fa-twitter"></i></a>
26+
<a class="margin-right:15px" data-share_network='facebook' title="Share on Facebook"><i class="fab fa-facebook"></i></a>
27+
<a class="margin-right:15px" data-share_network='instagram' title="Share on instagram"><i class="fab fa-instagram"></i></a>
28+
<a class="margin-right:15px" data-share_network='share' title="Share on share"><i class="fas fa-share-alt"></i></a>
2929
</div>
3030
</div>
3131
<p class="max-width:500px margin:20px_0px">A simple HTML5, CSS and pure javascript component. Easy configuration using data-attributes and highly styleable.</p>
32-
<div id="boilerplate-section" class="display:flex flex-wrap:wrap">
32+
<div id="docs-section" class="display:flex flex-wrap:wrap">
3333
<div class="flex-grow:1 width:300px padding:0px_10px margin:20px_0px">
34-
<h2 class="border-bottom:1px_solid_lightgrey padding:5px_0px">Install</h2>
35-
<pre><code class="language-javascript">npm install cocreate-boilerplate</code></pre>
34+
<div id="docs-install" class="border-bottom:1px_solid_lightgrey">
35+
<span class="display:flex align-items:center" data-hover="display:block!important" data-hover_target='[href="#docs-install"]'>
36+
<h2 class="padding:5px_0px">Install</h2>
37+
<a class="margin-left:10px display:none" href="#docs-install"><i class="fas fa-link"></i></a>
38+
</span>
39+
</div>
40+
<pre><code class="language-bash">npm i @cocreate/docs</code></pre>
3641
<p class="padding:10px_0px">Or you can use cdn link:</p>
37-
<pre><code class="language-javascript">https://cdn.cocreate.app/CoCreate-boilerplate.min.js</code></pre>
42+
<pre><code class="language-html">&lt;script&gt;https://cdn.cocreate.app/docs/latest/CoCreate-docs.min.js&lt;/script&gt;</code></pre>
3843

39-
<h2 class="border-bottom:1px_solid_lightgrey margin-top:80px padding:5px_0px">Usage</h2>
44+
<div id="docs-usage" class="margin-top:80px border-bottom:1px_solid_lightgrey">
45+
<span class="display:flex align-items:center" data-hover="display:block!important" data-hover_target='[href="#docs-usage"]'>
46+
<h2 class="padding:5px_0px">Usage</h2>
47+
<a class="margin-left:10px display:none" href="#docs-usage"><i class="fas fa-link"></i></a>
48+
</span>
49+
</div>
4050
<div class="">
41-
<p class="padding:10px_0px">This is boilerplate reference</p>
51+
<p class="padding:10px_0px">This is docs reference</p>
4252

4353
<div class="flex-grow:1 min-width:300px width:100%">
4454
<pre>
45-
<code>&lt;div&gt;&lt;/div&gt;</code>
55+
<code class="language-html">&lt;div&gt;&lt;/div&gt;</code>
4656
</pre>
4757
</div>
48-
<p class="padding:10px_0px">This is boilerplate reference</p>
49-
<p class="padding:10px_0px">This is boilerplate reference</p>
58+
<p class="padding:10px_0px">This is docs reference</p>
59+
<p class="padding:10px_0px">This is docs reference</p>
60+
</div>
61+
<div id="docs-attributes" class="margin-top:80px border-bottom:1px_solid_lightgrey">
62+
<span class="display:flex align-items:center" data-hover="display:block!important" data-hover_target='[href="#docs-attributes"]'>
63+
<h2 class="padding:5px_0px">Attributes</h2>
64+
<a class="margin-left:10px display:none" href="#docs-attributes"><i class="fas fa-link"></i></a>
65+
</span>
5066
</div>
51-
<h2 class="border-bottom:1px_solid_lightgrey padding:5px_0px">Attributes</h2>
5267
<ul class="list-style-type:none ">
5368
<li class="padding:15px_0px border-bottom:1px_solid_lightgrey">
54-
<h4><span>data-boilerplate</span> <span class="cocreate-badge success">string</span> <span class="cocreate-badge warning">optional</span></h4>
55-
<p>boilerplate-attribute</p>
69+
<h4><span>data-docs</span> <span class="cocreate-badge success">string</span> <span class="cocreate-badge warning">optional</span></h4>
70+
<p>docs-attribute</p>
5671
</li>
5772
<li class="padding:15px_0px border-bottom:1px_solid_lightgrey">
58-
<h4><span>data-boilerplate</span> <span class="cocreate-badge success">string</span> <span class="cocreate-badge warning">optional</span></h4>
59-
<p>boilerplate-attribute</p>
73+
<h4><span>data-docs</span> <span class="cocreate-badge success">string</span> <span class="cocreate-badge warning">optional</span></h4>
74+
<p>docs-attribute</p>
6075
</li>
6176
</ul>
6277
</div>
6378

6479
<div class="flex-grow:1 width:300px padding:0px_10px margin:20px_0px border-bottom:1px_solid_lightgrey">
6580
<!-- SandBox -->
66-
<h2 class="border-bottom:1px_solid_lightgrey padding:5px_0px">Demo</h2>
81+
<div id="docs-demo" class="border-bottom:1px_solid_lightgrey">
82+
<span class="display:flex align-items:center" data-hover="display:block!important" data-hover_target='[href="#docs-demo"]'>
83+
<h2 class="padding:5px_0px">Demo</h2>
84+
<a class="margin-left:10px display:none" href="#docs-demo"><i class="fas fa-link"></i></a>
85+
</span>
86+
</div>
6787
<div class="position:sticky top:0 padding:15px_0px height:100vh">
6888
<div class="container svColumn overflow:hidden card border-radius:2px width:auto height:100%" id="form-sandbox">
6989
<div class="font-size:20px position:absolute top:10px right:10px opacity:0.6 z-index:7">

‎result.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[[{"collection":"docs","data":{"description":"Css comment extract example\n testing....\n end","extension":".css","file_path":"./test_files/box-shadow.css"},"metaData":"./test_files/box-shadow.css"}],[{"collection":"docs","data":{"description":"CoCreateAction's init function","extension":".js","file_path":"./test_files/CoCreate-action.js"},"metaData":"./test_files/CoCreate-action.js"}],[{"collection":"docs","data":{"description":"updateDocument({\n collection: \"test123\",\n document_id: \"document_id\",\n data:{\n \texample: “some example can be html json etc”,\n \tdescription: “update documnets if document does not exist otherwise create”\n },\n })","extension":".js","file_path":"./test_files/CoCreate.js"},"metaData":"./test_files/CoCreate.js"},{"collection":"docs","data":{"description":"readDocument({\n collection: \"test123\",\n document_id: \"document_id\",\n element: “xxxx”,\n metaData: \"xxxx\",\n exclude_fields: [] \n })","extension":".js","file_path":"./test_files/CoCreate.js"},"metaData":"./test_files/CoCreate.js"},{"collection":"docs","data":{"description":"deleteDocument({\n namespace: '',\n room: '',\n broadcast: true/false,\n broadcast_sender: true/false,\n \n collection: \"module\",\n document_id: \"\",\n element: “xxxx”,\n metadata: \"xxxx\"\n })","extension":".js","file_path":"./test_files/CoCreate.js"},"metaData":"./test_files/CoCreate.js"}],[{"collection":"docs","data":{"description":"<script src=\"https://server.cocreate.app/js/CoCreate.min.js\"></script>\r\n\t\t\r\n\t\tParse <testing class=\"\"></testing>\r\n\t\ttesting...","extension":".html","file_path":"./test_files/test.html"},"metaData":"./test_files/test.html"}]]
1+
[[{"collection":"docs","data":{"description":"Css comment extract example\n testing....\n end","extension":".css","file_path":"./test_files/box-shadow.css"},"metaData":"./test_files/box-shadow.css"}],[{"collection":"docs","data":{"description":"CoCreateAction's init function","extension":".js","file_path":"./test_files/CoCreate-action.js"},"metaData":"./test_files/CoCreate-action.js"}],[{"collection":"docs","data":{"description":"updateDocument({\n collection: \"test123\",\n document_id: \"document_id\",\n data:{\n \texample: “some example can be html json etc”,\n \tdescription: “update documnets if document does not exist otherwise create”\n },\n })","extension":".js","file_path":"./test_files/CoCreate.js"},"metaData":"./test_files/CoCreate.js"},{"collection":"docs","data":{"description":"readDocument({\n collection: \"test123\",\n document_id: \"document_id\",\n element: “xxxx”,\n metaData: \"xxxx\",\n exclude_fields: [] \n })","extension":".js","file_path":"./test_files/CoCreate.js"},"metaData":"./test_files/CoCreate.js"},{"collection":"docs","data":{"description":"deleteDocument({\n namespace: '',\n room: '',\n broadcast: true/false,\n broadcast_sender: true/false,\n \n collection: \"module\",\n document_id: \"\",\n element: “xxxx”,\n metadata: \"xxxx\"\n })","extension":".js","file_path":"./test_files/CoCreate.js"},"metaData":"./test_files/CoCreate.js"}],[{"collection":"docs","data":{"description":"<script src=\"https://cdn.cocreate.app/latest/CoCreate.min.js\"></script>\r\n\t\t\r\n\t\tParse <testing class=\"\"></testing>\r\n\t\ttesting...","extension":".html","file_path":"./test_files/test.html"},"metaData":"./test_files/test.html"}]]

0 commit comments

Comments
 (0)