Permalink
Browse files

Add codox with markdown to project.clj

  • Loading branch information...
1 parent e38b11f commit 6208b26e21fe4ffecacb8403ed340ee5e2cd4ae6 @hugoduncan committed Mar 16, 2012
Showing with 89 additions and 0 deletions.
  1. +1 −0 project.clj
  2. +43 −0 test-resources/codox/index_template.html
  3. +45 −0 test-resources/codox/ns_template.html
View
@@ -3,6 +3,7 @@
:url "http://github.com/hugoduncan/criterium"
:dependencies [[org.clojure/clojure "1.3.0"]]
:local-repo-classpath true
+ :codox {:writer codox-md.writer/write-docs}
:autodoc {:name "Criterium"
:description "A benchmarking library."
:copyright "Copyright Hugo Duncan 2010, 2011, 2012. All rights reserved."
@@ -0,0 +1,43 @@
+<!doctype html>
+<html lang="en">
+ <head>
+ <title>project title</title>
+ <link rel="stylesheet" type="text/css" href="css/default.css"/>
+ <script src="js/jquery.min.js" type="text/javascript"></script>
+ <script src="js/page_effects.js" type="text/javascript"></script>
+ </head>
+ <body>
+ <header>
+ <div id="header">
+ <h1 class="project-title"></h1>
+ </div>
+ </header>
+ <navigation>
+ <div class="sidebar" id="namespaces">
+ <h3>Namespaces</h3>
+ <ul class="ns-links">
+ <li class="ns-link"><a href="">namespace</a></li>
+ </ul>
+ </div>
+ </navigation>
+ <article>
+ <div class="namespace-index" id="content">
+ <h2>YEAH</h2>
+ <h2 class="project-title">Project Title</h2>
+ <div class="doc">project description</div>
+ <div class="project-namespaces">
+ <div class="namespace">
+ <h3 class="ns-link"><a href="">namespace name</a></h3>
+ <div class="doc">namespace doc</div>
+ <div class="index ns-var-links">
+ <p>Public variables and functions:</p>
+ <ul>
+ <li class="ns-var-link"><a href="">var</a></li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </div>
+ </article>
+ </body>
+</html>
@@ -0,0 +1,45 @@
+<!doctype html>
+<html lang="en">
+ <head>
+ <title>namespace title</title>
+ <link rel="stylesheet" type="text/css" href="css/default.css"/>
+ <script src="js/jquery.min.js" type="text/javascript"></script>
+ <script src="js/page_effects.js" type="text/javascript"></script>
+ </head>
+ <body>
+ <header>
+ <div id="header">
+ <h1 class="project-title"></h1>
+ </div>
+ </header>
+ <navigation>
+ <div class="sidebar" id="namespaces">
+ <h3>Namespaces</h3>
+ <ul class="ns-links">
+ <li class="ns-link"><a href="">namespace</a></li>
+ </ul>
+ </div>
+ <div class="sidebar" id="vars">
+ <h3>Public Vars</h3>
+ <ul class="ns-var-links">
+ <li class="ns-var-link"><a href="">var</a></li>
+ </ul>
+ </div>
+ </navigation>
+ <article>
+ <div class="namespace-docs" id="content">
+ <h2 class="namespace-title">Namespace Title</h2>
+ <div class="doc">namespace doc</div>
+ <div class="ns-vars">
+ <div class="public">
+ <h3>var name</h3>
+ <div class="usage">
+ <code class="usage">arglist</code>
+ </div>
+ <div class="doc">docs</div>
+ </div>
+ </div>
+ </div>
+ </article>
+ </body>
+</html>

0 comments on commit 6208b26

Please sign in to comment.