Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
doc
 
 
js
 
 
 
 
ops
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

An effort to create a central documentation hub for the Clojure & ClojureScript ecosystem.

For Library Authors | Contributing | Website | ClojuTRE Talk

πŸ‘‹ Need help getting started? Say hi on Telegram, Twitter or Clojurians Slack in #cljdoc.

CircleCI cljdoc All Contributors slack

Rationale

πŸ“Ή I (Martin) gave a talk at ClojuTRE about cljdoc which is probably a good intro if you want to understand what cljdoc is and why it exists. If you prefer text, read on for the Rationale.

Publishing Clojure library documentation is an often manual and error prone process. Library authors who want to provide documentation need to set up tooling to create such documentation, host it and keep it updated. In combination all these steps introduce a significant amount of friction that often leads to there not being any HTML documentation at all. If there is documentation it's often only a matter of time until it's out of date with the latest release.

In short: Publishing documentation is hard. Harder than it has to be.

By fully automating the process of publishing documentation we can take a great burden from the shoulders of library maintainers and let them focus on shipping great libraries with great documentation.

A central place and consistent UI for all Clojure/Script library documentation will also make it easier for developers to find and work with documentation.

By centralizing this publishing process we can also build up a global understanding of the Clojure/Script ecosystem enabling many more interesting use-cases down the road.

Goals

  • Provide an easy way to host library documentation for Clojure/Script library authors
  • Deal with all the boring stuff: hosting, updating, keeping old versions around
  • Build an ecosystem-encompassing database (+ API) of artifacts, namespaces and their contents.
  • Support API documentation, articles and examples.
  • Encourage the writing of more and better documentation.

Contributing

  1. Take look at our Contributing file
  2. Get up and running by following the steps in Running cljdoc locally
  3. Understand why things are the way they are by reading our Architecture Decision Records

Contributors

Michiel Borkent
Michiel Borkent

πŸ“– πŸ›
Avichal
Avichal

πŸ’»
Daw-Ran Liou
Daw-Ran Liou

πŸ’» πŸ“– πŸ’΅
Anton S
Anton S

πŸ’»
Nikita Prokopov
Nikita Prokopov

πŸ’» πŸ“–
Daniel Compton
Daniel Compton

πŸ’» πŸš‡
samihda
samihda

πŸ’»
saskali
saskali

πŸ’»
Jorin Vogel
Jorin Vogel

πŸ“– πŸ’»
Albrecht Schmidt
Albrecht Schmidt

πŸ’»
Angus Fletcher
Angus Fletcher

πŸ’» πŸ“–
greg
greg

πŸ’»
Martin RačÑk
Martin RačÑk

πŸš‡ πŸ’»
Nikola Peric
Nikola Peric

πŸ’»
Matt Huebert
Matt Huebert

πŸ’» 🎨
el arbaoui oussama
el arbaoui oussama

πŸ’»
Martin Kavalar
Martin Kavalar

πŸ’»
Bozhidar Batsov
Bozhidar Batsov

πŸ“–
Dominic Monroe
Dominic Monroe

πŸ“– πŸ’»
Roman Liutikov
Roman Liutikov

🎨 πŸ’»
Mike Fikes
Mike Fikes

πŸ“–
Anthony Galea
Anthony Galea

πŸ’»
Dennis Schridde
Dennis Schridde

πŸ“–
jsimpson-ovo
jsimpson-ovo

πŸ’»
Travis McNeill
Travis McNeill

πŸ’»
Alex Dixon
Alex Dixon

πŸ’» ⚠️
Timothy Pratley
Timothy Pratley

πŸ’»
Kim Kinnear
Kim Kinnear

πŸ’»
Karl Sutt
Karl Sutt

πŸ’»
Tommi Reiman
Tommi Reiman

πŸ’»
Paulus Esterhazy
Paulus Esterhazy

πŸ’»
Eero Helenius
Eero Helenius

πŸ’»
Nicolas Berger
Nicolas Berger

πŸ’΅
Andrew Oberstar
Andrew Oberstar

πŸ’΅
Camilo Polymeris
Camilo Polymeris

πŸ’΅
Ryan Robitaille
Ryan Robitaille

πŸ’΅
julien bille
julien bille

πŸ’΅
Robert Medeiros
Robert Medeiros

πŸ’΅
Sean Corfield
Sean Corfield

πŸ’¬
Jakub Holy
Jakub Holy

πŸ’» πŸ“–
Lee Read
Lee Read

πŸ“– πŸ’» πŸ‘€ πŸ’¬ 🎨
Nicolas Ha
Nicolas Ha

πŸ’»
Matti HΓ€nninen
Matti HΓ€nninen

πŸ“–
Jacob O'Bryant
Jacob O'Bryant

πŸ’»
Shuai Lin
Shuai Lin

πŸ’»
Jimmy Miller
Jimmy Miller

πŸ’» 🚧
Tony Kay
Tony Kay

πŸ›
Toby Crawley
Toby Crawley

πŸ› πŸ’»
ROZAR Fabien
ROZAR Fabien

πŸ“–
Dmitry Palamarchuk
Dmitry Palamarchuk

πŸ’»

License

EPL-2.0 see LICENSE