The server hosting Gren's packaging site.
Read the official announcement to learn more.
When installing this package through npm, you will get a binary called gren-doc-preview.
Execute this while standing in a Gren package directory, and a server will be hosted on http://localhost:3000 (by default) with the documentation of that package, as it will look on the official package site.
This preview'er currently doesn't do auto-reloading, so you'll need to relaunch the binary every time you make a change to the documentation, or use a tool like watchexec.
By default, the packaging site will run on port 3000 and the documentation will be stored in an in-memory database. Both of these can be changed using environment variables:
PORTsets the port the server listen onGREN_PACKAGES_DATABASEsets a path where a sqlite database containing the documentation will be stored.GREN_CANONICAL_URLused for making urlsDISCORD_WEBHOOKused to notify the discord community of new packagesJSON_LOG_INGEST_URLurl to service that takes logs in jsonl format. If not provided, logs will be written to stdout.
We use nix for local development and deployment. If you don't want to use nix, you can find
the dependencies we use by looking at shell.nix.