fes

commit b593aa26f05c230c550c0bdb6e5e7f4eaefae1f2
parent fb8dc3cb90bbbf916e1e2bc401933e7fd9461bca
Author: vx-clutch <[email protected]>
Date:   Sat, 27 Dec 2025 19:16:59 -0500

doc: update documentation

Diffstat:
M
index.html
 | 
65
+++++++++++++++++++++++++++++++++++++++++++++++++++++------------

1 file changed, 53 insertions(+), 12 deletions(-)
diff --git a/index.html b/index.html
@@ -183,6 +183,7 @@ footer {
 				<li><a href="#introduction">Introduction</a></li>
 				<li><a href="#installation">Installation</a></li>
 				<li><a href="#usage">Usage</a></li>
+				<li><a href="#quick">Quick Start</a></li>
 				<li><a href="#cli-reference">Cli Reference</a></li>
 				<li><a href="#reference">Reference</a></li>
 			</ul>
@@ -210,6 +211,34 @@ footer {
 			</ul>
 		</section>
 
+		<section id="quick">
+			<h2>Quick Start</h2>
+			<pre><code>fes new hello</code></pre>
+			<p>This creates a new project under the name <code>hello</code>.</p>
+			<pre><code>fes run hello</code></pre>
+			<p>This runs your project <code>hello</code>, by default at <a href="localhost:3000" target="_blank">localhost:3000</a>.</p>
+			<h3>Extensions</h3>
+			<p>Let's add a paragraph to this simple site. Right now you have the following page:</p>
+			<pre><code>local fes = require("fes")
+local site = fes.fes()
+
+-- site.copyright = fes.util.copyright("https://fsd.vxserver.dev", "vx-clutch")
+
+site:h1("Hello, World!")
+
+return site</code></pre>
+			<p>To add a simple paragraph modify like so:</p>
+			<pre><code>local fes = require("fes")
+local site = fes.fes()
+
+-- site.copyright = fes.util.copyright("https://fsd.vxserver.dev", "vx-clutch")
+
+site:h1("Hello, World!")
+site:p("This is a paragraph")
+
+return site</code></pre>
+		</section>
+
 		<section id="cli-reference">
 			<h2>Cli Reference</h2>
 			<table> <thead>
@@ -220,18 +249,6 @@ footer {
 				</thead>
 				<tbody>
 					<tr>
-						<td><code>--help</code></td>
-						<td>Display help information</td>
-					</tr>
-					<tr>
-						<td><code>--no-color</code></td>
-						<td>Disable color output</td>
-					</tr>
-					<tr>
-						<td><code>-p &lt;port&gt;</code></td>
-						<td>Set the server port</td>
-					</tr>
-					<tr>
 						<td><code>new &lt;project&gt;</code></td>
 						<td>Create a new projet called &lt;project&gt;</td>
 					</tr>
@@ -243,6 +260,30 @@ footer {
 						<td><code>run &lt;project&gt;</code></td>
 						<td>Run the projet called &lt;project&gt;</td>
 					</tr>
+					<tr>
+						<td><code>-help</code></td>
+						<td>Display help information.</td>
+					</tr>
+					<tr>
+						<td><code>-V1</code></td>
+						<td>Print extended version information, this is very helpful when it comes to bug reporting.</td>
+					</tr>
+					<tr>
+						<td><code>-no-color</code></td>
+						<td>Disable color output.</td>
+					</tr>
+					<tr>
+						<td><code>-p &lt;port&gt;</code></td>
+						<td>Set the server port.</td>
+					</tr>
+					<tr>
+						<td><code>-static</code></td>
+						<td>Render and save all pages. (this feature is yet to be implemented)</td>
+					</tr>
+					<tr>
+						<td><code>-version</code></td>
+						<td>Print the version.</td>
+					</tr>
 				</tbody>
 			</table>
 		</section>