Don’t exclude docc directory When running from CLI this throws up a warning but when excluded it’s not included when building the documentation
Don’t exclude docc directory
When running from CLI this throws up a warning but when excluded it’s not included when building the documentation
VaporDocC provides middleware for use with Vapor. To initialise the middleware pass in the path to your .doccarchive, e.g.:
VaporDocC
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.
A docker image that wraps a Vapor app using the VaporDocCMiddleware is provided at ghcr.io/josephduffy/vapordocc.
VaporDocCMiddleware
To run locally mount the docs at /docs, e.g.:
/docs
docker run -p 8080:8080 -v /path/to/VaporDocC.doccarchive:/docs ghcr.io/josephduffy/vapordocc
VaporDocC
VaporDocC
provides middleware for use with Vapor. To initialise the middleware pass in the path to your .doccarchive, e.g.: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.: