Gustwind

Gustwind is a Deno-powered website creator that allows component-oriented development of large-scale sites using HTMLisp, a variant of HTML. Conceptually, it is split as follows:

  • Development mode lets you preview the site and modify page definitions to commit later
  • Production mode generates pure static HTML with CSS inlined to the files
  • HTMLisp is the default option for [templating]{/templating/} and component definitions
  • Data sources define how information is brought to a site
  • Route definition binds it all together and allows connecting data sources to specific routes
  • Plugin system allows replacing any part of the system to fit custom requirements

Please see the documentation to learn more about the concepts.

Getting started

There is a simple GitHub template that has basic features set up. It renders the project readme as index.html, and you should expand/change the project to your liking.

Data flow

Gustwind accepts TypeScript, Markdown, and HTMLisp definitions. Then, the build process emits HTML and JavaScript. Note that you can replace many aspects of the system by using plugins to fit your requirements. The image below describes the basic idea:

Gustwind data flow

It's possible to customize the input formats and it can load data from asynchronous sources, say GraphQL APIs, so Gustwind can be used with headless content APIs.

Server-Side Rendering (SSR)

Although Gustwind was designed mainly with Static Site Generation (SSG) in mind, portions of it can be used in a server environment. There's for example a simplified version of the router designed for this purpose, and the default templating solution works both in server and client as it is light by design.

Example sites

Given Gustwind is still in a rapid development phase, the APIs change every once in a while. The source of this site is the most up to date resource, and I've listed other examples below:

Performance

In my experience, Gustwind is somewhat performant although I haven't benchmarked it. The main factors contributing to speed are its parallelized build process and light rendering engine. There are still ways to push it further by implementing techniques, like incremental compilation to compile only pages affected by a given change. The underlying architecture has been designed with advanced features in mind, so although they aren't trivial to implement, they aren't impossible if there is time and interest.

  • Tailspin was an experimental site generator built with partially the same technology. In this project, the ideas have been largely re-implemented and taken further. In some ways, Tailspin went further, though, as it implemented component level introspection (types) and editors while allowing JSX syntax.
  • Antwar was a React-based static site generator. The experiences with Antwar over years, have been put to good use in this project.