Skip to content
Dive deeper into your code
Clojure HTML CSS
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs @ 26384fb
example
lein
src/hydrox
template
test
.gitignore
.gitmodules
.travis.yml
LICENSE
README.md
hydrox.graffle
project.clj

README.md

hydrox

Build Status

dive deeper into your code

hydrox logo

Installation

In your project.clj, add hydrox to the [:profiles :dev :dependencies] entry:

(defproject ...
  ...
  :plugins ["lein-hydrox" "0.1.15"]
  :profiles {:dev {:dependencies [...
                                  [helpshift/hydrox "0.1.15"]
                                  ...]}}
  ...)

Leiningen

To initialise a project:

lein hydrox init

To generate documentation (watches project for changes and updates documentation accordingly):

lein hydrox

Tutorials

Overview

hydrox assists in the transmission of knowledge around a clojure project, providing in-repl management of documentation, docstrings and metadata through the reuse/repurposing of test code. The tool allows for a design-orientated workflow for the programming process, blurring the boundaries between design, development, testing and documentation.

hydrox overview

Please see the docs for more information (generated using itself).

Links and References:

  • the generated website for hara can be seen here

  • the .html output can be seen for a sample .clj input

License

Copyright © 2015 Helpshift

Distributed under the Eclipse Public License either version 1.0 or (at your option) any later version.

You can’t perform that action at this time.