A collection of small helpers to ingest data provided via API analysis
or Git repositories into the database (see cljdoc.storage.api
)
A collection of small helpers to ingest data provided via API analysis or Git repositories into the database (see [[cljdoc.storage.api]])
Weaves together the various HTTP components of cljdoc.
Routing and HTTP concerns are handled via Pedestal and
endpoints are implemented as intereceptors.
For more details on routing see cljdoc.server.routes
.
The main aspects handlded via HTTP (and thus through this namespace) are:
view
)show-build
& all-builds
)sitemap-interceptor
)request-build
, [[full-build]] & [[circle-ci-webhook]])version-resolve-redirect
& jump-interceptor
)Weaves together the various HTTP components of cljdoc. Routing and HTTP concerns are handled via Pedestal and endpoints are implemented as [intereceptors](http://pedestal.io/reference/interceptors). For more details on routing see [[cljdoc.server.routes]]. The main aspects handlded via HTTP (and thus through this namespace) are: - Rendering documentation pages (see [[view]]) - Rendering build logs (see [[show-build]] & [[all-builds]]) - Rendering a sitemap (see [[sitemap-interceptor]]) - Handling build requests (see [[request-build]], [[full-build]] & [[circle-ci-webhook]]) - Redirecting to newer releases (see [[version-resolve-redirect]] & [[jump-interceptor]])
Based on this excellent guide: http://pedestal.io/guides/hello-world-content-types
Based on this excellent guide: http://pedestal.io/guides/hello-world-content-types
Pedestals routing is pretty nice but tying the routing table too much to the handlers can be annoying when trying to generate routes outside of a Pedestal server (e.g. when rendering files statically.)
This namespace lists all routes of cljdoc and exposes some utility functions to generate URLs given the routing information.
With some more work this could probably also be used from ClojureScript.
For use with http handlers a route-resolver
can be passed when
generating all routes. See docstring of routes
for details.
Pedestals routing is pretty nice but tying the routing table too much to the handlers can be annoying when trying to generate routes outside of a Pedestal server (e.g. when rendering files statically.) This namespace lists all routes of cljdoc and exposes some utility functions to generate URLs given the routing information. With some more work this could probably also be used from ClojureScript. For use with http handlers a `route-resolver` can be passed when generating all routes. See docstring of `routes` for details.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close