package soupault

  1. Overview
  2. Docs
Static website generator based on HTML rewriting

Install

Dune Dependency

Authors

Maintainers

Sources

4.8.0.tar.gz
md5=e9c26a1687a7500d9c45bec2d852fbb6
sha512=9d072529e85b477af934bf83d5bf97dd50e8d43c7c3b73650e9b085277ebd7859da9aa91292b1d3171fd0c7b468e6df70806d3549fe5fb685922d8d6f98eeb61

Description

A website generator that works with page element tree rather than text and allows you to manipulate pages and retrieve metadata from existing HTML using arbitrary CSS selectors.

With soupault you can:

  • Generate ToC and footnotes.
  • Insert file content or an HTML snippet in any element.
  • Preprocess element content with external programs (e.g. run <pre> tags through a highlighter)
  • Extract page metadata (think microformats) and render it using a Jingoo template or an external script.
  • Export extracted metadata to JSON.

Soupault is extensible with Lua (2.5) plugins and provides an API for element tree manipulation, similar to web browsers.

The website generator mode is optional, you can use it as post-processor for existing sites.

Published: 01 Feb 2024

README

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.

Soupault works with the HTML element tree of the page, so it can do many things that traditionally could be done with client-side JS: inject new HTML into existing complete pages, create a table of contents that preserves the id elements of HTML headings and more.

It also doesn't use front matter and extracts metadata from HTML instead, using a CSS3 selector to metadata field mapping, so even hand-written static pages can be indexed rather than treated as assets. For example:

[index.fields.title]
  # Try to find <h1 id="post-title"> if it exists,
  # else use the first <h1> 
  selector = ["h1#post-title", "h1"]

[index.fields.excerpt]
  selector = ["p#post-excerpt", "p"]

[index.fields.date]
  selector = ["time#post-date", "time"]
  extract_attribute = "datetime"
  fallback_to_content = true

Extracted metadata can then be rendered and injected into pages:

[index.views.blog]
  # Insert rendered data into the element that matches "#blog-index" CSS selector.
  index_selector = "#blog-index"
  index_item_template = """
    <h2><a href="{{url}}">{{title}}</a></h2>
    <p><strong>Last update:</strong> {{date}}.</p>
    <p>{{excerpt}}</p>
    <a href="{{url}}">Read more</a>
  """

Soupault is...

  • Durable and easy to upgrade or roll back: it's available as a statically-linked binary with no dependencies.

  • Extensible: you can bring your own page preprocessors (e.g. Markdown to HTML convertors), pipe HTML elements through external programs, and load Lua plugins.

  • Flexible: most options are configurable, most built-in features can be reimplemented as Lua plugins, and there are page processing hooks.

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

Visit soupault.app for details.

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

Installation

Pre-built binaries are available for Linux, Windows, and macOS. You can download them from https://files.baturin.org/software/soupault and from Github releases (https://github.com/dmbaturin/soupault/releases).

You can verify release archive integrity using this signify/minisign key: RWRfW+gkhk/+iA7dOUtTio6G6KeJCiAEp4Zfozw7eqv2shN90+5z20Cy.

You can also install stable release versions from OPAM:

opam install soupault

Finally, you can build the latest development version with:

opam pin add git+https://github.com/PataphysicalSociety/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 contribute either through GitHub or through Codeberg.

Dependencies (21)

  1. lua-ml >= "0.9.3"
  2. tsort >= "2.1.0"
  3. digestif >= "0.7.3"
  4. camomile >= "2.0.0"
  5. jingoo >= "1.4.2"
  6. base64 >= "3.0.0"
  7. spelll >= "0.4"
  8. odate >= "0.6"
  9. re >= "1.9.0"
  10. csv >= "2.4"
  11. yaml >= "2.0.0"
  12. ezjsonm >= "1.2.0"
  13. otoml >= "1.0.4"
  14. markup >= "1.0.0-1"
  15. lambdasoup >= "1.0.0"
  16. fmt >= "0.8.9"
  17. logs >= "0.7.0"
  18. fileutils >= "0.6.3"
  19. containers >= "3.9"
  20. dune >= "2.0.0"
  21. ocaml >= "4.13"

Dev Dependencies

None

Used by

None

Conflicts (1)

  1. result < "1.5"