🐫 In a startup pitch style, it's a website generator for Markdown haters.

https://discuss.ocaml.org/t/ann-soupault-a-static-website-generator-based-on-html-rewriting/4126
https://baturin.org/projects/soupault/

Daniil Baturin 6be6495bc4 Use OCaml 4.09.1 for Travis builds. 1 week ago
examples 24a7fbd0a1 Expose the widget config to plugins. 7 months ago
sample-site cc2c36dc77 Fix the sample site config to work with recent versions (fixes #3). 7 months ago
src b024a65780 Bump version to 1.10 1 week ago
.gitignore c7346c31cb Initial commit 10 months ago
.travis.yml 6be6495bc4 Use OCaml 4.09.1 for Travis builds. 1 week ago
LICENSE c7346c31cb Initial commit 10 months ago
README.md 9e4e072899 Add the signify/minisign public key to the README. 1 month ago
dune f17e457c3f First prototype. 9 months ago
dune-project 31205f9837 Update the version for new dependencies. 3 months ago
soupault.opam b024a65780 Bump version to 1.10 1 week ago

README.md

soupault

Soupault is an HTML manipulation tool. It can be any of:

  • static site generator
  • HTML processor
  • metadata extractor

or all of them at the same time.

It builds on the idea that HTML is a machine-readable format.

Client-side JavaScript has always been used to manipulate pages in-browser. For manipulating pages on disk, people traditionally used template processors. Soupault can parse an HTML page into an element tree, manipulate elements, and save the result to disk.

Web scrapers have been used for extracting data from someone else's pages. Microformats have been used to let other people know what to extract. For their own pages, people usually used "front matter". Soupault allows you to define your own "microformats" on the fly. For example, automatically use the first <h1>, or <h1 id="title"> for the page <title>. You can define your own fields based on CSS selectors and export the index to JSON, then make a HTML page with a blog archive or an RSS/Atom/JSONFeed from it.

Static site generators have been either easily extensible but written in interpreted languages or shipped as static binaries but self-contained. Soupault is an easy to install static binary, but it embeds a Lua interpreter that has access to the page element tree. Much like the DOM API for JS, but for Lua.

It's also friendly to existing websites. Clean URLs are optional. Assembling pages from a template and a body is also optional: if you page has an <html> element, it's excluded from the assembly stage. You can disable "templating", or mix unique and templated pages.

Soupault is named after the French dadaist and surrealist writer Philippe Soupault because it's based on the lambdasoup library.

Visit https://soupault.neocities.org for details.

For support and discussion, write a message to the mailing list.

Installation

Pre-built binaries for Linux, Windows, and mac OS are available from the website and from Github releases.

You can verify the binaries using this signify/minisign key: RWRfW+gkhk/+iA7dOUtTio6G6KeJCiAEp4Zfozw7eqv2shN90+5z20Cy.

You can also install the latest stable releases from OPAM:

opam install soupault

Finally, you can build the last source with:

opam pin add git+https://github.com/dmbaturin/soupault

Contributing

Bug reports and patches are always welcome. Feature requests and new features are also welcome, but please consider discussing them with the maintainer first.

You can submit patches either as Github pull requests or send them to the Sourcehut mailing list.