Skip to content

Move to elementary-swift #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sliemeobn merged 4 commits into from
Dec 8, 2025
Merged

Move to elementary-swift #86

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1719c06
updated readme
sliemeobn Dec 8, 2025
312b157
note box
sliemeobn Dec 8, 2025
2faaecf
wip
sliemeobn Dec 8, 2025
b7bc75c
Update README.md
sliemeobn Dec 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,14 @@

**A modern and efficient HTML rendering library - inspired by SwiftUI, built for the web.**

[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fsliemeobn%2Felementary%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/sliemeobn/elementary) [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fsliemeobn%2Felementary%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/sliemeobn/elementary)
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fsliemeobn%2Felementary%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/elementary-swift/elementary) [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fsliemeobn%2Felementary%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/elementary-swift/elementary)

[Examples](#play-with-it) | [Motivation](#motivation-and-other-packages) | [Discussion](https://github.com/sliemeobn/elementary/discussions)
> [!IMPORTANT]
>
> This repo 📦 moved 📦 to its new home at **`https://github.com/elementary-swift`**.
> Please update your URLs to avoid trouble - and reach out if anything breaks!

[Examples](#play-with-it) | [Motivation](#motivation-and-other-packages) | [Discussion](https://github.com/elementary-swift/elementary/discussions)

```swift
struct MainPage: HTMLDocument {
Expand All @@ -25,7 +30,7 @@ struct MainPage: HTMLDocument {
"Framework agnostic and unopinionated",
])

a(.href("https://github.com/sliemeobn/elementary"), .class("fancy-style")) {
a(.href("https://github.com/elementary-swift/elementary"), .class("fancy-style")) {
"Learn more"
}
}
Expand All @@ -49,7 +54,7 @@ struct FeatureList: HTML {

Add the dependency to `Package.swift`
```swift
.package(url: "https://github.com/sliemeobn/elementary.git", from: "0.3.2")
.package(url: "https://github.com/elementary-swift/elementary.git", from: "0.6.0")
.product(name: "Elementary", package: "elementary")
```

Expand All @@ -67,17 +72,17 @@ Integration with [Vapor](https://github.com/vapor-community/vapor-elementary)

## Play with it

Check out the [Hummingbird + Tailwind example app](https://github.com/sliemeobn/elementary/tree/main/Examples/HummingbirdDemo).
Check out the [Hummingbird + Tailwind example app](https://github.com/elementary-swift/elementary/tree/main/Examples/HummingbirdDemo).

For a demo of [ElementaryHTMX](https://github.com/sliemeobn/elementary-htmx), see this [Hummingbird + HTMX Demo](https://github.com/sliemeobn/elementary-htmx/tree/main/Examples/HummingbirdDemo).
For a demo of [ElementaryHTMX](https://github.com/elementary-swift/elementary-htmx), see this [Hummingbird + HTMX Demo](https://github.com/elementary-swift/elementary-htmx/tree/main/Examples/HummingbirdDemo).

For a Vapor example, see the [Vapor + HTMX Demo](https://github.com/sliemeobn/elementary-htmx/tree/main/Examples/VaporDemo).
For a Vapor example, see the [Vapor + HTMX Demo](https://github.com/elementary-swift/elementary-htmx/tree/main/Examples/VaporDemo).

## Lightweight and fast

Elementary renders straight to text, optimized for serving generated HTML from a [Hummingbird](https://github.com/hummingbird-project/hummingbird) or [Vapor](https://vapor.codes/) server app.

Any type conforming to `HTML` can be rendered individually, ideal for testing or for sending fragments with [htmx](https://github.com/sliemeobn/elementary-htmx).
Any type conforming to `HTML` can be rendered individually, ideal for testing or for sending fragments with [htmx](https://github.com/elementary-swift/elementary-htmx).

The default rendering mechanism produces chunks of HTML for efficient response streaming, so the browser can start loading a page while the server is still producing the rest of it. Swift concurrency is used to handle back pressure, so you your memory footprint stays low even for large pages.

Expand Down