39 lines
1.1 KiB
Lua
39 lines
1.1 KiB
Lua
local fes = require("fes")
|
|
local site = fes.site_builder()
|
|
|
|
site.title = "Fes Documentation"
|
|
|
|
site:h1("Fes Documentation")
|
|
site:note([[
|
|
This is the documentation for the Fes
|
|
Microframework. This documentation serves as
|
|
a starting point and in its current state is
|
|
not comprehensive. Furthermore, you should
|
|
note that Fes is not production grade or
|
|
stable, use at your own caution.
|
|
]])
|
|
|
|
site:muted("Before reading this you should consult the " .. fes.std.external("https://git.vxserver.dev/fSD/fes", "README"))
|
|
|
|
local docs = {}
|
|
|
|
local template = [[
|
|
<span class="highlight">%s</span> %s
|
|
]]
|
|
function docs:func(fn, desc)
|
|
table.insert(self, string.format(template, fn, desc))
|
|
return self
|
|
end
|
|
|
|
docs:func("fes.site_builder", "returns a site object, a required element for this framework.")
|
|
docs:func("site:h1", "adds a h1 to the site object.")
|
|
docs:func("site:h2", "adds a h2 to the site object.")
|
|
docs:func("site:h3", "adds a h3 to the site object.")
|
|
docs:func("site:h4", "adds a h4 to the site object.")
|
|
docs:func("site:h5", "adds a h5 to the site object.")
|
|
docs:func("site:h6", "adds a h6 to the site object.")
|
|
|
|
site:note(table.concat(docs, "\n<br><br>\n"))
|
|
|
|
return site
|