clo/sitegen
1
0
Fork 0
Code Issues 20 Pull requests Projects Releases Packages Wiki Activity Actions

update readme

Browse source 
Update readme.md
This commit is contained in:
clover caruso 2025-06-13 00:29:30 -07:00
parent 5267ab30ac
commit 23aeb893e4
1 changed files with 70 additions and 67 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
readme.md
View file

@ -13,10 +13,15 @@ that assist building websites. these tools power https://paperclover.net.
- The only difference in development and production mode is hidden - The only difference in development and production mode is hidden
source-maps and stripped assertions and `console.debug` calls. The site source-maps and stripped assertions and `console.debug` calls. The site
you see locally is the site you see deployed. you see locally is the site you see deployed.
- Tools for building complex, content heavy web sites. - (TODO) Tests, Lints, and Type-checking is run alongside, and only re-runs
checks when the files change. For example, changing a component re-tests
only pages that use that component and re-lints only the changed file.
- Integrated libraries for building complex, content heavy web sites.
- Static asset serving with ETag and build-time compression. - Static asset serving with ETag and build-time compression.
- Dynamic server side rendering from within backend code. - Dynamicly rendered pages with static client. (`#import "#sitegen/view"`)
- Databases with a typed SQLite wrapper. - Databases with a typed SQLite wrapper. (`import "#sitegen/sqlite"`)
- TODO: Meta and Open Graph generation. (`export const meta`)
- TODO: Font subsetting tools to reduce
- Built on the battle-tested Node.js runtime. Partial support for Deno and Bun. - Built on the battle-tested Node.js runtime. Partial support for Deno and Bun.
[1]: https://next.markojs.com [1]: https://next.markojs.com
@ -45,21 +50,19 @@ npm install
# production generation # production generation
node run generate node run generate
node .clover/out/server
# live development environment # "development" watch mode
node repl node run watch
``` ```
`repl.js` will open a read-eval-print-loop where plugin state is cached (on my <!-- `repl.js` will open a read-eval-print-loop where plugin state is cached (on my -->
2014 dev laptop, startup time is 600-1000ms). every file in `framework` and <!-- 2014 dev laptop, startup time is 600-1000ms). every file in `framework` and -->
`src` besides `hot.ts` can be edited and quickly re-run. for example, to run <!-- `src` besides `hot.ts` can be edited and quickly re-run. for example, to run -->
`framework/generate.ts`, you can type "generate" into the shell. since <!-- `framework/generate.ts`, you can type "generate" into the shell. since -->
top-level await is not supported (plugins are built on `require` as Node has <!-- top-level await is not supported (plugins are built on `require` as Node has -->
poor module support), CLIs can include a `main` function, which is executed <!-- poor module support), CLIs can include a `main` function, which is executed -->
when the REPL runs it. <!-- when the REPL runs it. -->
TODO: in the future, the repl will have a "dev" command which will do the incremental
site build + host, possibly immediatly on opening the repl.
## Contributions ## Contributions