diff options
author | Colin Okay <59481711+cbeo@users.noreply.github.com> | 2021-06-09 18:08:00 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-06-09 18:08:00 -0500 |
commit | 95b2090e21f7aada157f07b9cda809a756865993 (patch) | |
tree | ef18fa87a8c05544a2403de3b670e69110907e2c | |
parent | 5e3a745a8b6df0934c1331a03e60c399598b36d3 (diff) |
Update README.md
-rw-r--r-- | README.md | 34 |
1 files changed, 34 insertions, 0 deletions
@@ -1,4 +1,38 @@ # flexo +*alpha quality software* + The Common Lisp, interactive system for static site generation. +For an example of a site made with flexo, see [my site's source](https://github.com/cbeo/hyperthings.garden) + +The idea is this: + +1. You make a recipe that builds your site +2. The recipe first adds "resources", which are usually files on disk +3. The recipie then uses those resources to build "artifacts", which are mostly pages. +4. You then publish and deploy. + +## Interactive development + +The real benefit of flexo is interactive development. + +If you run the function + + (hack-on 'my-site-recipe #P/tmp/flexo-hack-space/" :port 4242) + +The you can do things like add new resources and recompile the functions that build artifact and the site will automatically redisplay. + +## Future development + +- Separate `spinneret`, `LASS`, and `parenscript` template macros into their own packages +- Document the CLOS Protocol that Flexo uses, including how to extend it to: + - Make your own artifacts + - Make your own resources + - Make your own deployment styles +- Add resources as: + - Entire separate document trees for importing "subsites" + - Database Queries as resources, not just files + - API calls as resources, not just files + + |