This page is not created by, affiliated with, or supported by Slack Technologies, Inc.
2018-07-18
Channels
- # aleph (4)
- # beginners (70)
- # cider (66)
- # clara (16)
- # cljdoc (20)
- # cljs-dev (9)
- # cljsrn (2)
- # clojure (36)
- # clojure-ecuador (2)
- # clojure-italy (14)
- # clojure-japan (2)
- # clojure-nl (22)
- # clojure-uk (79)
- # clojurescript (133)
- # clojutre (2)
- # code-reviews (5)
- # cursive (5)
- # data-science (1)
- # datomic (47)
- # duct (2)
- # emacs (1)
- # figwheel-main (3)
- # fulcro (11)
- # funcool (1)
- # graphql (6)
- # hyperfiddle (4)
- # leiningen (4)
- # luminus (9)
- # lumo (8)
- # mount (4)
- # nrepl (2)
- # off-topic (19)
- # onyx (1)
- # re-frame (23)
- # reagent (91)
- # reitit (17)
- # ring-swagger (2)
- # shadow-cljs (43)
- # tools-deps (27)
- # vim (45)
Did a lot of documentation writing today, most importantly this guide for library authors. If any of you have 5-10 minutes โ Iโd be thankful for any feedback ๐ https://github.com/cljdoc/cljdoc/blob/master/doc/userguide/for-library-authors.md
https://github.com/cljdoc/cljdoc/blob/master/doc/userguide/for-library-authors.md
@martinklepsch use asciidoc, no more manual toc ๐
Haha, yeah, I should probably do that
Good timing. I have huge library to document.
Do you have a helloworld repo that illustrates all the features?
What if I use the github wiki pages to do documentation? Will #cljdoc pick that up?
@hiskennyness cljdoc links releases to specific git commits and uses a checkout at that commit to build documentation. Since this kind of linking is not easily possible with wikis it does not support wikis.
We might be able to support this using submodules in some way but for now Iโd encourage you to version your code and documentation alongside each other
@hiskennyness as for examples:
- There is https://cljdoc.xyz/d/metosin/muuntaja/0.6.0-SNAPSHOT/doc/readme with a custom cljdoc.edn
.
- If you donโt expect to need nested articles you can also just name your files in a sortable way, their first heading will be used as title in the sidebar: https://github.com/functionalfoundry/macros/tree/master/docs
Yes, I saw the bit on sortable naming. Reminded me of the good old days of Basic line numbering where we left gaps so we could add subcontent. ๐
haha, yeah, I suppose you could do that ๐
@hiskennyness let me know if you run into any issues, have more questions/ideas etc ๐
What about github wiki pages? Sorry of I am being dense.
@hiskennyness Did you miss this message perhaps? https://clojurians.slack.com/archives/C8V0BQ0M6/p1531935625000529
Ok, so I can just go with a bunch of .mdโs in a docs directory and number them intelligently, or use the edn trick to organize them hierarchically.
Yes, or you can even use asciidoc ๐