From c6bc5b30563fee18395dcf87d55d17a53510c0cd Mon Sep 17 00:00:00 2001 From: vx-clutch Date: Thu, 22 Jan 2026 22:27:34 -0500 Subject: [PATCH] update doc page --- docs.fsdproject.org/include/header.lua | 9 - docs.fsdproject.org/static/fes.html | 232 ++++++++++++++++------ docs.fsdproject.org/static/index.html | 263 +++++++++++++++++++++++++ docs.fsdproject.org/www/index.lua | 27 ++- 4 files changed, 453 insertions(+), 78 deletions(-) delete mode 100644 docs.fsdproject.org/include/header.lua create mode 100644 docs.fsdproject.org/static/index.html diff --git a/docs.fsdproject.org/include/header.lua b/docs.fsdproject.org/include/header.lua deleted file mode 100644 index e1f02ac..0000000 --- a/docs.fsdproject.org/include/header.lua +++ /dev/null @@ -1,9 +0,0 @@ -local header = {} - -header.render = function(std) - return table.concat({ - std.center(std.ha("/", std.h1("Free Software Distributions Project documentation"))), - }) -end - -return header diff --git a/docs.fsdproject.org/static/fes.html b/docs.fsdproject.org/static/fes.html index 26a9b1f..1bfec22 100644 --- a/docs.fsdproject.org/static/fes.html +++ b/docs.fsdproject.org/static/fes.html @@ -276,10 +276,6 @@ return site -p <port> Set the server port. - - -static - Render and save all pages. (this feature is yet to be implemented) - -version Print the version. @@ -305,7 +301,7 @@ return site Generate a site object - :custom() + :g() Add a custom string to the site body @@ -323,30 +319,6 @@ return site - - std.fes_version() - Get the current version of fes. - - - std.site_version() - Get the current version of the site, defined in Fes.toml. - - - std.site_name() - Get the current name of the site, defined in Fes.toml. - - - std.site_title() - Get the current name of the site, defined in Fes.toml. - - - std.site_authors() - Get a table of the authors of the site, defined in Fes.toml. - - - std.join - Get a table of the authors of the site, defined in Fes.toml. - std.a(link: string, str: string) Returns an anchor tag. @@ -448,7 +420,7 @@ return site Returns a div of class class with content of content. - std.spa(content: string, class: string) + std.span(content: string, class: string) Returns a span of class class with content of content. @@ -486,15 +458,179 @@ return site - symbol.copyright - © + symbol.legal.copyright + © - Registered Trademark - ® + symbol.legal.registered_trademark + ® - Trademark - ™ + symbol.legal.trademark + ™ + + + symbol.currency.euro + € + + + symbol.currency.pound + £ + + + symbol.currency.yen + ¥ + + + symbol.currency.cent + ¢ + + + symbol.currency.dollar + $ + + + symbol.currency.plus_minus + ± + + + symbol.currency.multiply + × + + + symbol.currency.divide + ÷ + + + symbol.currency.not_equal + ≠ + + + symbol.currency.less_equal + ≤ + + + symbol.currency.greater_equal + ≥ + + + symbol.currency.infinity + ∞ + + + symbol.currency.approx + ≈ + + + symbol.arrows.left + ← + + + symbol.arrows.right + → + + + symbol.arrows.up + ↑ + + + symbol.arrows.down + ↓ + + + symbol.arrows.left_right + ↔ + + + symbol.punctuation.left_double_quote + “ + + + symbol.punctuation.right_double_quote + ” + + + symbol.punctuation.left_single_quote + ‘ + + + symbol.punctuation.right_single_quote + ’ + + + symbol.punctuation.ellipsis + … + + + symbol.punctuation.em_dash + — + + + symbol.punctuation.en_dash + – + + + symbol.whitespace.non_breaking +   + + + symbol.whitespace.thin +   + + + symbol.symbols.degree + ° + + + symbol.symbols.micro + µ + + + symbol.symbols.section + § + + + symbol.symbols.paragraph + ¶ + + + symbol.symbols.check + ✓ + + + symbol.symbols.cross + ✗ + + + symbol.symbols.bullet + • + + + symbol.symbols.middle_dot + · + + + symbol.symbols.broken_bar + ¦ + + + symbol.html.less_than + < + + + symbol.html.greater_than + > + + + symbol.html.ampersand + & + + + symbol.html.double_quote + " + + + symbol.html.single_quote + ' @@ -553,28 +689,6 @@ return site -

Site

- - - - - - - - - - - - - - - - - - - - -
NameDescription
site.versionThe version of the website found in the Fes.toml
site.nameThe name of the website found in the Fes.toml
site.authorsA table of all authors defined in Fes.toml

App

Fes's app module is a special table because it contains user defined functions. These @@ -627,7 +741,7 @@ return hello This can be called from another with, diff --git a/docs.fsdproject.org/static/index.html b/docs.fsdproject.org/static/index.html new file mode 100644 index 0000000..6aa98f4 --- /dev/null +++ b/docs.fsdproject.org/static/index.html @@ -0,0 +1,263 @@ + + + + + + Documentation + + + +
+
+

Documentation

+

Yait: Yet Another Init Tool

+
+ + + +
+

Introduction

+

Yait, or Yet Another Init Tool, is a small shell script that templates minimal programs. It provides argument parsing and a general framework for your projects.

+
+ +
+

Installation

+ 
git clone https://git.vxserver.dev/fSD/yait
+ 
cd fes
+ 
sudo make install
+
+ +
+

Quick Start

+ 
yait hello
+

This creates a C project.

+ 
yait -x sh hello
+

This creates a SH project.

+ +
+

Cli Reference

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
--helpDisplay help information.
--versionPrint version information.
-x <language>Set project language.
-d <description>Set a description.
-Ssmall project creation (only for shell scripts)
-foverwrite existing files
-d <author>Disable color output.
-rInitalize a Git repository.
-qSuppress non-critical output.
+
+ + +
+ + diff --git a/docs.fsdproject.org/www/index.lua b/docs.fsdproject.org/www/index.lua index 57a720c..0147838 100644 --- a/docs.fsdproject.org/www/index.lua +++ b/docs.fsdproject.org/www/index.lua @@ -1,22 +1,29 @@ local fes = require("fes") + local std = fes.std local u = fes.util local site = fes.fes() -local title = "Free Software Distributions Project documentation" - -site.title = title -site.copyright = u.copyright("https://git.vxserver.dev/fSD", "fSD") +site.title = "Free Software Distributions Documentation" +site.copyright = fes.util.copyright("https://fsdproject.org", "fSD") site.favicon = "/static/favicon.ico" - -site:banner(fes.app.header.render(std)) +site:banner(fes.util.cc { + fes.std.center(fes.std.ha("/", fes.std.h1("Free Software Distributions"))), +}) site:note(u.cc { - std.h2("Documentation pages"), - std.ul { - std.a("static/fes.html", "fes"), - } + std.center(std.h1("Online fSD manuals")), + std.note(u.cc { + std.center(std.h3("Fes")), + std.a("/static/fes.html", std.h4("Fes")), + std.p("  Free Easy Site Online Documentation. [" .. std.a("https://fsdproject.org/releases/fes", "fes home") .. "]"), + }), + std.note(u.cc { + std.center(std.h3("Tools")), + std.a("/static/yait.html", std.h4("Yait")), + std.p("  Yet Another Init Tool Online Documentation. [" .. std.a("https://fsdproject.org/releases/yait", "yait home") .. "]"), + }) }) return site