https://github.com/pataphysicalsociety/soupault
Static website generator based on HTML element tree rewriting
https://github.com/pataphysicalsociety/soupault
hacktoberfest html-processor lua ocaml static-site-generator web
Last synced: 17 days ago
JSON representation
Static website generator based on HTML element tree rewriting
- Host: GitHub
- URL: https://github.com/pataphysicalsociety/soupault
- Owner: PataphysicalSociety
- License: mit
- Created: 2019-06-02T14:54:40.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-09-06T12:11:48.000Z (8 months ago)
- Last Synced: 2024-10-29T15:54:21.554Z (6 months ago)
- Topics: hacktoberfest, html-processor, lua, ocaml, static-site-generator, web
- Language: OCaml
- Homepage: https://soupault.app
- Size: 979 KB
- Stars: 378
- Watchers: 11
- Forks: 18
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
soupault
========
Soupault is an HTML manipulation tool. It can be a static site generator
or an HTML (post-)processor for existing websites and allows you to define
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 respects and uses `id`'s of HTML headings and more.
It also doesn't use front matter but extracts metadata from HTML instead: you tell it what to extract using CSS3 selectors,
so even hand-written static pages can be indexed rather than treated as opaque assets.
For example, here's what a content model for a blog may look like:
```toml
# Post title
[index.fields.title]
# Try to find
,
# else use the first
selector = ["h1#post-title", "h1"]
# Fail the build if post title cannot be found
required = true
# Post excerpt
[index.fields.excerpt]
# Use
if a page has it,
# else use the first paragraph.
# This allows using a paragraph other than the first one
# as the post excerpt.
selector = ["p#post-excerpt", "p"]
# Post date
[index.fields.date]
selector = ["time#post-date", "time"]
# Extract the datetime="" attribute from the
# If there's no datetime attribute in
Extracted metadata can then be rendered and injected into pages:
```toml
[index.views.blog]
# Insert rendered data into the element that matches "#blog-index" CSS selector.
index_selector = "#blog-index"
index_item_template = """
{{title}}
Last update: {{date}}.
{{excerpt}}
Read more
"""
```
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](https://soupault.app/reference-manual/#page-preprocessors)
(e.g., Markdown to HTML convertors), define [asset processors](https://soupault.app/reference-manual/#asset-processing)
(e.g., a Sass/Less compiler, an image optimizer),
pipe HTML elements through [external programs](https://soupault.app/reference-manual/#preprocess-element-widget),
and load [Lua plugins](https://soupault.app/plugins/).
* Flexible: most options are configurable, most built-in features can be reimplemented as Lua plugins,
and there are [page processing hooks](https://soupault.app/reference-manual/#page-processing-hooks).
Soupault is named after [Philippe Soupault](https://en.wikipedia.org/wiki/Philippe_Soupault),
a French dadaist and surrealist writer and poet,
because it uses [lambdasoup](http://aantron.github.io/lambdasoup/) library to work with tag soups.
Visit [soupault.app](https://www.soupault.app) for details.
For support and discussion, write a message to the [mailing list](https://lists.sr.ht/~dmbaturin/soupault).
# Installation
Prebuilt binaries are available for Linux (x86-64 and Aarch64), Windows, and macOS (x86-64).
You can download them from https://files.baturin.org/software/soupault
and from GitHub releases (https://github.com/PataphysicalSociety/soupault/releases).
You can verify release archive integrity using this minisign key:
```
minisign -VP RWRfW+gkhk/+iA7dOUtTio6G6KeJCiAEp4Zfozw7eqv2shN90+5z20Cy -m
```
You can also install stable release versions from [OPAM](https://opam.ocaml.org):
```sh
opam install soupault
```
Finally, you can build the latest development version with:
```sh
opam pin add git+https://github.com/PataphysicalSociety/soupault
```
To build static binaries, you need to install OCaml with musl runtime,
then use the `static` Dune profile:
```
# For OCaml 4.14.2, adjust for your desired version
opam switch create 4.14.2-musl ocaml-variants.4.14.2+options ocaml-option-musl ocaml-option-static
opam switch 4.14.2-musl
# Build static binaries
dune build --profile=static
```
# 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](https://github.com/PataphysicalSociety/soupault)
or through [Codeberg](https://codeberg.org/PataphysicalSociety/soupault).