huge getting started documentation

OSSPhilippines · Sep 4, 2024 · bc6e1bf · bc6e1bf
1 parent 61dce35
commit bc6e1bf
Show file tree

Hide file tree

Showing 33 changed files with 7,144 additions and 57,525 deletions.
diff --git a/docs/build/client/13781afd4fbd704a9789.js b/docs/build/client/13781afd4fbd704a9789.js
diff --git a/docs/build/client/1bf701a55aaad047771e.js b/docs/build/client/1bf701a55aaad047771e.js
diff --git a/docs/build/client/269f8b60f20cebb43be6.js b/docs/build/client/269f8b60f20cebb43be6.js
diff --git a/docs/build/client/2d721d6aed73f41f4e72.js b/docs/build/client/2d721d6aed73f41f4e72.js
diff --git a/docs/build/client/3550a936d66e61695120.js b/docs/build/client/3550a936d66e61695120.js
diff --git a/docs/build/client/38ccffadc3c6e8b93d28.js b/docs/build/client/38ccffadc3c6e8b93d28.js
diff --git a/docs/build/client/3e6a90cc5da3e950a902.js b/docs/build/client/3e6a90cc5da3e950a902.js
diff --git a/docs/build/client/57e37fa233b38c87fe71.js b/docs/build/client/57e37fa233b38c87fe71.js
diff --git a/docs/build/client/75ff7698b5db04ad540c.js b/docs/build/client/75ff7698b5db04ad540c.js
diff --git a/docs/build/client/8f2ff6d48aec3c3f0dc4.js b/docs/build/client/8f2ff6d48aec3c3f0dc4.js
diff --git a/docs/build/client/a67341498153885a2fc0.html b/docs/build/client/a67341498153885a2fc0.html
diff --git a/docs/build/client/a67341498153885a2fc0.js b/docs/build/client/a67341498153885a2fc0.js
diff --git a/docs/build/client/f01cefc94e8ee605f3f5.js b/docs/build/client/f01cefc94e8ee605f3f5.js
diff --git a/docs/build/client/f859bf7a335e9eba03e0.js b/docs/build/client/f859bf7a335e9eba03e0.js
diff --git a/docs/build/server/13781afd4fbd704a9789.js b/docs/build/server/13781afd4fbd704a9789.js
diff --git a/docs/build/server/1bf701a55aaad047771e.js b/docs/build/server/1bf701a55aaad047771e.js
diff --git a/docs/build/server/269f8b60f20cebb43be6.js b/docs/build/server/269f8b60f20cebb43be6.js
diff --git a/docs/build/server/2d721d6aed73f41f4e72.js b/docs/build/server/2d721d6aed73f41f4e72.js
diff --git a/docs/build/server/3550a936d66e61695120.js b/docs/build/server/3550a936d66e61695120.js
diff --git a/docs/build/server/38ccffadc3c6e8b93d28.js b/docs/build/server/38ccffadc3c6e8b93d28.js
diff --git a/docs/build/server/3e6a90cc5da3e950a902.js b/docs/build/server/3e6a90cc5da3e950a902.js
diff --git a/docs/build/server/57e37fa233b38c87fe71.js b/docs/build/server/57e37fa233b38c87fe71.js
diff --git a/docs/build/server/75ff7698b5db04ad540c.js b/docs/build/server/75ff7698b5db04ad540c.js
diff --git a/docs/build/server/8f2ff6d48aec3c3f0dc4.js b/docs/build/server/8f2ff6d48aec3c3f0dc4.js
diff --git a/docs/build/server/a67341498153885a2fc0.js b/docs/build/server/a67341498153885a2fc0.js
diff --git a/docs/build/server/f01cefc94e8ee605f3f5.js b/docs/build/server/f01cefc94e8ee605f3f5.js
diff --git a/docs/build/server/f859bf7a335e9eba03e0.js b/docs/build/server/f859bf7a335e9eba03e0.js
diff --git a/docs/docs/getting-started.html b/docs/docs/getting-started.html
diff --git a/docs/styles/theme.css b/docs/styles/theme.css
@@ -811,6 +811,7 @@ ide-app .body .panel-main {
   background-color: #000000;
   left: 150px;
   top: 45px;
+  right: 0;
 }
 
 @media (max-width: 767px) {

diff --git a/packages/temple-web/src/index.ts b/packages/temple-web/src/index.ts
@@ -12,11 +12,7 @@ type Next = () => void;
 const docs = path.join(__dirname, '../../../docs');
 
 //create temple compiler
-const compiler = temple({ 
-  brand: '',
-  cwd: __dirname,
-  minify: false
-});
+const compiler = temple({ brand: '', cwd: __dirname });
 
 //use temple ui
 compiler.use(tui({ brand: '' }));

diff --git a/packages/temple-web/src/modules/api/types.json b/packages/temple-web/src/modules/api/types.json
@@ -1092,13 +1092,6 @@
       "description": "The NodeJS EventEmitter instance being used.",
       "example": "import emitter from 'events';\n\nconst compiler = temple({ emitter });'"
     },
-    "type?": {
-      "kind": "property",
-      "list": false,
-      "type": ["document", "component", "template"],
-      "description": "Type of component",
-      "example": "const compiler = temple({ type: 'component' });'"
-    },
     "minify?": {
       "kind": "property",
       "list": false,
@@ -1933,5 +1926,127 @@
       "description": "Returns a signal object used to re-render components whenever its value changes",
       "example": "const count = TempleAPI.signal(1, component)"
     }
+  },
+  "Render Methods": {
+    "asset": {
+      "kind": "function",
+      "async": true,
+      "args": [
+        {
+          "kind": "property",
+          "list": false,
+          "name": "assetFile",
+          "type": "string"
+        }
+      ],
+      "returns": {
+        "kind": "property",
+        "list": false,
+        "type": "Asset"
+      },
+      "description": "Returns a compiled build asset, given an asset file name.",
+      "example": "await compiler.asset('abc123.css'); //--> { type: 'text/css', content: '...' }"
+    },
+    "client": {
+      "kind": "function",
+      "async": true,
+      "args": [
+        {
+          "kind": "property",
+          "list": false,
+          "name": "sourceFile",
+          "type": "string"
+        }
+      ],
+      "returns": {
+        "kind": "property",
+        "list": false,
+        "type": "string"
+      },
+      "description": "Returns a compiled client script, given the the template source file.",
+      "example": "await compiler.client('./docs/api.dtml'); //client script"
+    },
+    "markup": {
+      "kind": "function",
+      "async": true,
+      "args": [
+        {
+          "kind": "property",
+          "list": false,
+          "name": "sourceFile",
+          "type": "string"
+        }
+      ],
+      "returns": {
+        "kind": "property",
+        "list": false,
+        "type": "string"
+      },
+      "description": "Returns a compiled markup, given the the template source file.",
+      "example": "await compiler.markup('./docs/api.dtml'); //--> <html>...</html>"
+    },
+    "render":  {
+      "kind": "function",
+      "async": true,
+      "args": [
+        {
+          "kind": "property",
+          "list": false,
+          "name": "sourceFile",
+          "type": "string"
+        },
+        {
+          "kind": "property",
+          "list": false,
+          "name": "props",
+          "type": "Hash"
+        }
+      ],
+      "returns": {
+        "kind": "property",
+        "list": false,
+        "type": "string"
+      },
+      "description": "Returns the final HTML markup, given the the template source file.",
+      "example": "await compiler.render('./docs/api.dtml', {\n  title: 'API Documentation'\n});"
+    },
+    "server": {
+      "kind": "function",
+      "async": true,
+      "args": [
+        {
+          "kind": "property",
+          "list": false,
+          "name": "sourceFile",
+          "type": "string"
+        }
+      ],
+      "returns": {
+        "kind": "property",
+        "list": false,
+        "type": "string"
+      },
+      "description": "Returns compiled server code, given the the template source file.",
+      "example": "await compiler.server('./docs/api.dtml'); // server script"
+    },
+    "styles": {
+      "kind": "function",
+      "async": true,
+      "args": [
+        {
+          "kind": "property",
+          "list": false,
+          "name": "sourceFile",
+          "type": "string"
+        }
+      ],
+      "returns": {
+        "kind": "property",
+        "list": false,
+        "type": "string"
+      },
+      "description": "Returns compiled css styles, given the the template source file.",
+      "example": "await compiler.styles('./docs/api.dtml'); //css styles"
+    }
   }
 }
diff --git a/packages/temple-web/src/modules/api/ui.tml b/packages/temple-web/src/modules/api/ui.tml
@@ -173,7 +173,9 @@
       <table class="tbl">
         <thead>
           <th>Property</th>
-          <th>Returns</th>
+          <if false={active.value.includes('Emitter')}>
+            <th>Returns</th>
+          </if>
           <th>Description</th>
         </thead>
         <tbody>
@@ -217,7 +219,6 @@
                 </if>
               <elif true={prop.kind === 'event'} />
                 <td valign="top" nowrap>{`on('${key}', (event: Event) => void)`}</td>
-                <td valign="top" nowrap>void</td>
               </if>
               <td>
                 <if true={prop.description}>