Liking cljdoc? Tell your friends :D

cljdoc.util

Utility functions :)

These are available in the analysis environment and thus should work without any additional dependencies.

Utility functions :)

These are available in the analysis environment and thus
should work without any additional dependencies.
raw docstring

artifact-idclj

(artifact-id project)

assert-firstclj

(assert-first [x & rest :as xs])

cljdoc-ednclj

(cljdoc-edn project version)

clojars-idclj

(clojars-id {:keys [group-id artifact-id] :as cache-id})

codox-ednclj

(codox-edn project version)

delete-directory!clj

(delete-directory! dir)

find-pom-in-dirclj

(find-pom-in-dir dir project)

gh-coordinateclj

(gh-coordinate gh-url)

gh-ownerclj

(gh-owner gh-url)

gh-repoclj

(gh-repo gh-url)

gh-url?clj

(gh-url? s)

git-dirclj

(git-dir project version)

github-urlclj

(github-url type)

group-idclj

(group-id project)

hardcoded-configclj


infer-platforms-from-src-dirclj

(infer-platforms-from-src-dir src-dir)

Given a directory src-dir inspect all files and infer which platforms the source files likely target.

Given a directory `src-dir` inspect all files and infer which
platforms the source files likely target.
raw docstring

normalize-git-urlclj

(normalize-git-url s)

Ensure that the passed string is a git URL and that it's using HTTPS

Ensure that the passed string is a git URL and that it's using HTTPS
raw docstring

normalize-projectclj

(normalize-project project)

pom-pathclj

(pom-path project)

relativize-pathclj

(relativize-path s1 s2)

Remove the segments at the beginning of a path s2 that are identical to the beginning segments of s1. This is useful when wanting to render relative links instead of absolute ones.

Example:

(relativize-path "doc/common-abc.html" "doc/common-xyz.html")
;; => "common-xyz.html"
Remove the segments at the beginning of a path `s2` that are identical
to the beginning segments of `s1`. This is useful when wanting to render
relative links instead of absolute ones.

Example:

```
(relativize-path "doc/common-abc.html" "doc/common-xyz.html")
;; => "common-xyz.html"
```
raw docstring

replant-nsclj

(replant-ns base target)

Given a fully-qualified base and a potentially relative target namespace, return the fully qualified version of target. Assumes that all target namespaces with identical first segments to base are already absolute.

Given a fully-qualified `base` and a potentially relative `target` namespace,
return the fully qualified version of `target`. Assumes that all `target` namespaces
with identical first segments to `base` are already absolute.
raw docstring

scm-fallbackclj


scm-urlclj

(scm-url pom-map)

system-temp-dirclj

(system-temp-dir prefix)

system-temp-fileclj

(system-temp-file prefix suffix)

uri-pathclj

(uri-path uri)

Return path part of a URL, this is probably part of pedestal in some way but I couldn't find it fast enough. TODO replace.

Return path part of a URL, this is probably part of pedestal in
some way but I couldn't find it fast enough. TODO replace.
raw docstring

version-tag?clj

(version-tag? pom-version tag)

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close