fes

Free Easy Site
Log | Files | Refs | README | LICENSE

README.md (769B)


      1 # Fes
      2 
      3 A lightweight, static, and opinionated microframework.
      4 
      5 ## Usage
      6 
      7 This is the `fes new <project>` output
      8 ```lua
      9 local fes = require("fes")
     10 local site = fes.fes()
     11 
     12 site:h1("Hello, World!")
     13 
     14 return site
     15 ```
     16 
     17 This can be ran with `fes run <project>` where `<project>` is the location of the website.
     18 
     19 ## Examples
     20 
     21 See `examples/` for different features, `canonical/` contains the best practices for this microframework.
     22 
     23 ## Build
     24 
     25 ```sh
     26 git clone https://git.vxserver.dev/fSD/fes.git
     27 cd fes
     28 
     29 go build .
     30 ./fes run examples/hello-world # if this works install
     31 
     32 go install fes
     33 ```
     34 
     35 ## Documentation
     36 
     37 Run `fes doc` for the documentation website or goto [docs.vxserver.dev](https://docs.vxserver.dev)
     38 
     39 ## License
     40 
     41 ISC License
     42 
     43 Copyright (C) 2025-2026 fSD
     44 
     45 See `COPYING`