Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: about 1 month 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 (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-21T17:40:30.000Z (8 months ago)
- Last Synced: 2024-05-16T22:27:52.946Z (7 months ago)
- Topics: hacktoberfest, html-processor, lua, ocaml, static-site-generator, web
- Language: OCaml
- Homepage: https://soupault.app
- Size: 896 KB
- Stars: 363
- Watchers: 11
- Forks: 16
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome-github-stars - PataphysicalSociety/soupault - Static website generator based on HTML element tree rewriting (OCaml)
- jimsghstars - PataphysicalSociety/soupault - Static website generator based on HTML element tree rewriting (OCaml)
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:
```toml
[index.fields.title]
# Try to find
if it exists,
# else use the first
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:
```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), 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 the French dadaist and surrealist writer [Philippe Soupault](https://en.wikipedia.org/wiki/Philippe_Soupault)
because it's based on the [lambdasoup](http://aantron.github.io/lambdasoup/) library.
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
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/PataphysicalSociety/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](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.12.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).