Swiftpack.co - JosephDuffy/VaporDocC as Swift Package

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
See all packages published by JosephDuffy.
JosephDuffy/VaporDocC v0.1.0
Vapor middleware that serves a DocC archive
⭐️ 23
🕓 2 years ago
macOS
.package(url: "https://github.com/JosephDuffy/VaporDocC.git", from: "v0.1.0")

VaporDocC

VaporDocC provides middleware for use with Vapor. To initialise the middleware pass in the path to your .doccarchive, e.g.:

let archiveURL = URL(fileURLWithPath: "/path/to/VaporDocC.doccarchive")
app.middleware.use(VaporDocCMiddleware(archivePath: archiveURL))

Documentation – hosted by the docker image included in this repo – is available at vapordocc.josephduffy.co.uk.

Docker

A docker image that wraps a Vapor app using the VaporDocCMiddleware is provided at ghcr.io/josephduffy/vapordocc.

To run locally mount the docs at /docs, e.g.:

docker run -p 8080:8080 -v /path/to/VaporDocC.doccarchive:/docs ghcr.io/josephduffy/vapordocc

GitHub

link
Stars: 23
Last commit: 2 years ago
Advertisement: IndiePitcher.com - Cold Email Software for Startups

Dependencies

Release Notes

v0.1.0
2 years ago
  • Support redirecting requests for the root (“/“)
  • Support redirecting requests with missing trailing slashes to include trailing slashes

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics