summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorColin Okay <59481711+cbeo@users.noreply.github.com>2021-06-10 07:19:21 -0500
committerGitHub <noreply@github.com>2021-06-10 07:19:21 -0500
commit0b3222e8c9745299b3deba4378d056e33e134468 (patch)
tree34d478407f4055af3d55dbfa88ee7d88ea80d17e
parent0f6c3072890bc52a3bc6bcf92a54ff35a7dcb91f (diff)
Update README.md
-rw-r--r--README.md18
1 files changed, 12 insertions, 6 deletions
diff --git a/README.md b/README.md
index f6cd973..6e14806 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ For an example of a site made with flexo, see [my site's source](https://github.
The idea is this:
1. You make a recipe that builds your site. It typically has two parts:
- - The recipe first adds "resources", which are usually files on disk
+ - The recipe first adds and classifies content resources, which are usually files on disk
- The recipie then uses those resources to build "artifacts", which are mostly pages.
2. You then pass the recipie to a function that builds and publishes the site.
@@ -42,6 +42,8 @@ The `page-with-main-layout` is a template defined like so:
```
Notice that the template is defined to accept a single argument `content-view`.
+When we called `page-with-main-layout` in our recipe above, we passed `index-page-content`
+as the `content-view` argument. This is just a function that prints to the spinneret html stream.
``` lisp
@@ -52,7 +54,10 @@ Notice that the template is defined to accept a single argument `content-view`.
```
-You can then build it to disk by doing:
+Right now, macros to define page templates are exclusively using spinneret, but there is
+no reason that other systems cannot be added.
+
+You can then build the site to disk by doing:
``` lisp
@@ -78,14 +83,15 @@ If you run the function
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:
+ - Make your own artifact classes
+ - Make your own content classes
+ - Make your own publication location classes (only publishing to disk is presently supported)
+- Add content as:
- Entire separate document trees for importing "subsites"
- Database Queries as resources, not just files
- API calls as resources, not just files