Bunch of changes for v2 #25

Merged

tonymottaz merged 12 commits from v2-changes into main

2026-04-15 15:15:17 +00:00

tonymottaz commented

2026-04-15 15:14:53 +00:00

Owner

The main changes are a simplification of the file naming conventions in the routes/ folder:

Handlers are named with +<method>.js where <method> is any HTTP method
Middleware handlers are still named +middleware.js
Files starting with an underscore are not served by Grackle
- _template.<ext> files are used by response.render() only to generate HTML responses
Static files: All other files are served as-is, and the filename (with extension) is included in route matching
- Vento files (*.vto) and Markdown files (*.md) are postprocessed into HTML, and the file extension is excluded from route-matching

Markdown rendering is now done with markdown-it.

GitHub-style alerts are supported
Syntax highlighting is supported using highlight.js, but you need to bring your own CSS to style them.

HMR works much better now. It is no longer enabled using NODE_ENV, but must be explicitly enabled with the --dev-hmr CLI option.

The new grackle docs command serves the bundled docs in a local server.

The main changes are a simplification of the file naming conventions in the `routes/` folder: - **Handlers** are named with `+<method>.js` where `<method>` is any HTTP method - **Middleware handlers** are still named `+middleware.js` - Files starting with an underscore are not served by Grackle - `_template.<ext>` files are used by `response.render()` only to generate HTML responses - **Static files:** All other files are served as-is, and the filename (with extension) is included in route matching - Vento files (`*.vto`) and Markdown files (`*.md`) are postprocessed into HTML, and the file extension is excluded from route-matching Markdown rendering is now done with markdown-it. - [GitHub-style alerts](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts) are supported - Syntax highlighting is supported using highlight.js, but you need to bring your own CSS to style them. HMR works much better now. It is no longer enabled using `NODE_ENV`, but must be explicitly enabled with the `--dev-hmr` CLI option. The new `grackle docs` command serves the bundled docs in a local server.

tonymottaz added 12 commits

2026-04-15 15:14:53 +00:00

prettier setup for markdown files 28dcd063e4

support static templates 3dd52bf96b

set up docs for serving with grackle 425291726f

consolidate markdown rendering logic b299558f90

npm audit fix 3a0c592eba

fix generation of route for static templates 53e9079e8b

add docs command to run documentation site with grackle 1595897e8e

upgrade biome e0e162fed2

[breaking] simplify file naming API, templating, and postprocessing ccb414176e

- now there are just handlers, static files, and ignored files
- handlers deal with the request-response details
- static files may optionally have a postprocessing pipeline to transform how they are served
- built-in pipelines for Vento and Markdown
- several internal changes to how user files are loaded, fixes HMR

update docs and example project 43d19607d7

switch to markdown-it 9f144a6ac7

update readme 7c4bf15dc0