用法

克隆 Slipstream 站点模板，以便快速开始将 Slipstream 站点部署到 GitHub Pages。

创建一个可执行的 Swift 包

mkdir mysite
cd mysite
swift package init --type executable

将 Slipstream 添加到你的包依赖项

Slipstream 需要 macOS 14。

platforms: [
  .macOS("14"),
],
dependencies: [
  .package(url: "https://github.com/jverkoey/slipstream.git", branch: "main"),
],
targets: [
  .executableTarget(name: "mysite", dependencies: [
    .product(name: "Slipstream", package: "slipstream"),
  ]
],

即可开始

import Foundation
import Slipstream

struct HelloWorld: View {
  var body: some View {
    Text("Hello, world!")
  }
}

print(try renderHTML(HelloWorld()))

渲染站点地图

Slipstream 有意避免对你的文档应如何组织结构和写入磁盘做出强烈的预设。不过，为了帮助你入门，你可以使用 Slipstream 的轻量级站点地图渲染器，将 Slipstream 视图字典写入磁盘

import Foundation
import Slipstream

struct HelloWorld: View {
  var body: some View {
    Text("Hello, world!")
  }
}

let sitemap: Sitemap = [
  "index.html": HelloWorld()
]

// Assumes this file is located in a Sources/ sub-directory of a Swift package.
guard let projectURL = URL(filePath: #filePath)?
  .deletingLastPathComponent()
  .deletingLastPathComponent() else {
  print("Unable to create URL for \(#filePath)")
  exit(1)
}

let outputURL = projectURL.appending(path: "site")

try renderSitemap(sitemap, to: outputURL)

文档

查看 Slipstream 的完整文档。

社区

要与其他 Slipstream 用户讨论 Slipstream 相关主题、提问或探索想法，请使用 GitHub 讨论区。