cljdoc

https://cljdoc.org/ & https://github.com/cljdoc/cljdoc
orestis 2019-02-05T18:30:44.089800Z

Is cljdoc only suited for libraries, or could I use it to build nice documentation for an internal project? That I would commit under say a local folder and people would just open using a file:// url?

πŸ™Œ 1
Avichal 2019-02-06T10:04:31.098100Z

This sounds like an interesting use case. People can self host at the organization level and can have pretty docs πŸ˜„

martinklepsch 2019-02-06T10:06:13.098300Z

I agree πŸ˜„

orestis 2019-02-06T14:57:32.099100Z

And perhaps a business case?

orestis 2019-02-06T14:58:24.099300Z

I mean, ideally I’d like if I can build and commit the generated docs side-by-side with my code. I don’t mind doing it manually. But setting up codox from scratch seems a little bit of a waste of time, esp. since cljdoc has much better looking output.

martinklepsch 2019-02-05T18:31:56.090100Z

hey. It's not really intended for that type of use case but you could commit an offline bundle into source control and view that using file:// urls

martinklepsch 2019-02-05T18:32:27.090300Z

Here's an example off an offline bundle: https://cljdoc.org/download/lambdaisland/uri/1.1.0

martinklepsch 2019-02-05T18:35:19.090800Z

Alternatively you could also run a cljdoc instance on your own infrastructure. Depending on how many libraries/releases/developers there are one might make more sense than the other