Skip to content

Commit

Permalink
Dual-platform docs, using forked Codox
Browse files Browse the repository at this point in the history
  • Loading branch information
ptaoussanis committed Jul 4, 2023
1 parent b7479ca commit 481e098
Show file tree
Hide file tree
Showing 40 changed files with 462 additions and 250 deletions.
23 changes: 20 additions & 3 deletions css/default.css
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,8 @@ h5.license {
h4.type,
h4.dynamic,
h4.added,
h4.deprecated {
h4.deprecated,
h4.lang {
float: left;
margin: 3px 10px 15px 0;
font-size: 15px;
Expand All @@ -336,15 +337,17 @@ h4.deprecated {
.public h4.type,
.public h4.dynamic,
.public h4.added,
.public h4.deprecated {
.public h4.deprecated,
.public h4.lang {
font-size: 13px;
font-weight: bold;
margin: 3px 0 0 10px;
}

.members h4.type,
.members h4.added,
.members h4.deprecated {
.members h4.deprecated,
.members h4.lang {
margin-top: 1px;
}

Expand All @@ -364,6 +367,20 @@ h4.deprecated {
color: #880000;
}

h4.lang {
color: #aaa;
font-weight: lighter;
}

h4.lang a {
color: #aaa;
font-weight: lighter;
}

h4.lang.current {
color: #a33;
}

.namespace {
margin-bottom: 30px;
}
Expand Down
12 changes: 12 additions & 0 deletions index.clj.html

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions index.cljs.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>Timbre 6.2.1</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Timbre</span> <span class="project-version">6.2.1</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 current"><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Platforms</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.clj.html"><div class="inner">Clojure</div></a></li><li class="depth-1 current"><a href="index.cljs.html"><div class="inner">ClojureScript</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>taoensso</span></div></div></li><li class="depth-2"><a href="taoensso.timbre.cljs.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>timbre</span></div></a></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>appenders</span></div></div></li><li class="depth-4"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>community</span></div></div></li><li class="depth-5"><a href="taoensso.timbre.appenders.community.node-spit.cljs.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>node-spit</span></div></a></li><li class="depth-4"><a href="taoensso.timbre.appenders.core.cljs.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>core</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Timbre</span> <span class="project-version">6.2.1</span></span></h1><h5 class="license">Released under the <a href="http://www.eclipse.org/legal/epl-v10.html">Eclipse Public License 1.0</a></h5><div class="doc"><p>Pure Clojure/Script logging library.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[com.taoensso/timbre "6.2.1"]</pre><h2>Platforms</h2><p>This project includes both Clojure and ClojureScript code:</p><ul><li><a href="index.clj.html">Clojure</a></li><li><a href="index.cljs.html">ClojureScript</a></li></ul><h2>Namespaces</h2><div class="namespace"><h3><a href="taoensso.timbre.cljs.html">taoensso.timbre</a></h3><div class="doc"><pre class="plaintext">Simple, flexible logging for Clojure/Script. No XML.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.timbre.cljs.html#var-*config*">*config*</a> </li><li> <a href="taoensso.timbre.cljs.html#var-*context*">*context*</a> </li><li> <a href="taoensso.timbre.cljs.html#var--log.21">-log!</a> </li><li> <a href="taoensso.timbre.cljs.html#var--log-and-rethrow-errors">-log-and-rethrow-errors</a> </li><li> <a href="taoensso.timbre.cljs.html#var--log-and-rethrow-errors">-log-and-rethrow-errors</a> </li><li> <a href="taoensso.timbre.cljs.html#var--log-errors">-log-errors</a> </li><li> <a href="taoensso.timbre.cljs.html#var--log-errors">-log-errors</a> </li><li> <a href="taoensso.timbre.cljs.html#var--logged-future">-logged-future</a> </li><li> <a href="taoensso.timbre.cljs.html#var--logged-future">-logged-future</a> </li><li> <a href="taoensso.timbre.cljs.html#var--spy">-spy</a> </li><li> <a href="taoensso.timbre.cljs.html#var--spy">-spy</a> </li><li> <a href="taoensso.timbre.cljs.html#var-console-.3Fappender">console-?appender</a> </li><li> <a href="taoensso.timbre.cljs.html#var-console-appender">console-appender</a> </li><li> <a href="taoensso.timbre.cljs.html#var-debug">debug</a> </li><li> <a href="taoensso.timbre.cljs.html#var-debug">debug</a> </li><li> <a href="taoensso.timbre.cljs.html#var-debugf">debugf</a> </li><li> <a href="taoensso.timbre.cljs.html#var-debugf">debugf</a> </li><li> <a href="taoensso.timbre.cljs.html#var-default-config">default-config</a> </li><li> <a href="taoensso.timbre.cljs.html#var-default-output-error-fn">default-output-error-fn</a> </li><li> <a href="taoensso.timbre.cljs.html#var-default-output-fn">default-output-fn</a> </li><li> <a href="taoensso.timbre.cljs.html#var-default-output-msg-fn">default-output-msg-fn</a> </li><li> <a href="taoensso.timbre.cljs.html#var-default-timestamp-opts">default-timestamp-opts</a> </li><li> <a href="taoensso.timbre.cljs.html#var-error">error</a> </li><li> <a href="taoensso.timbre.cljs.html#var-error">error</a> </li><li> <a href="taoensso.timbre.cljs.html#var-errorf">errorf</a> </li><li> <a href="taoensso.timbre.cljs.html#var-errorf">errorf</a> </li><li> <a href="taoensso.timbre.cljs.html#var-example-config">example-config</a> </li><li> <a href="taoensso.timbre.cljs.html#var-fatal">fatal</a> </li><li> <a href="taoensso.timbre.cljs.html#var-fatal">fatal</a> </li><li> <a href="taoensso.timbre.cljs.html#var-fatalf">fatalf</a> </li><li> <a href="taoensso.timbre.cljs.html#var-fatalf">fatalf</a> </li><li> <a href="taoensso.timbre.cljs.html#var-get-env">get-env</a> </li><li> <a href="taoensso.timbre.cljs.html#var-get-env">get-env</a> </li><li> <a href="taoensso.timbre.cljs.html#var-info">info</a> </li><li> <a href="taoensso.timbre.cljs.html#var-info">info</a> </li><li> <a href="taoensso.timbre.cljs.html#var-infof">infof</a> </li><li> <a href="taoensso.timbre.cljs.html#var-infof">infof</a> </li><li> <a href="taoensso.timbre.cljs.html#var-level.3E.3D">level&gt;=</a> </li><li> <a href="taoensso.timbre.cljs.html#var-log">log</a> </li><li> <a href="taoensso.timbre.cljs.html#var-log">log</a> </li><li> <a href="taoensso.timbre.cljs.html#var-log.21">log!</a> </li><li> <a href="taoensso.timbre.cljs.html#var-log.21">log!</a> </li><li> <a href="taoensso.timbre.cljs.html#var-log*">log*</a> </li><li> <a href="taoensso.timbre.cljs.html#var-log*">log*</a> </li><li> <a href="taoensso.timbre.cljs.html#var-log-and-rethrow-errors">log-and-rethrow-errors</a> </li><li> <a href="taoensso.timbre.cljs.html#var-log-and-rethrow-errors">log-and-rethrow-errors</a> </li><li> <a href="taoensso.timbre.cljs.html#var-log-env">log-env</a> </li><li> <a href="taoensso.timbre.cljs.html#var-log-env">log-env</a> </li><li> <a href="taoensso.timbre.cljs.html#var-log-errors">log-errors</a> </li><li> <a href="taoensso.timbre.cljs.html#var-log-errors">log-errors</a> </li><li> <a href="taoensso.timbre.cljs.html#var-log.3F">log?</a> </li><li> <a href="taoensso.timbre.cljs.html#var-logf">logf</a> </li><li> <a href="taoensso.timbre.cljs.html#var-logf">logf</a> </li><li> <a href="taoensso.timbre.cljs.html#var-logf*">logf*</a> </li><li> <a href="taoensso.timbre.cljs.html#var-logf*">logf*</a> </li><li> <a href="taoensso.timbre.cljs.html#var-logged-future">logged-future</a> </li><li> <a href="taoensso.timbre.cljs.html#var-logged-future">logged-future</a> </li><li> <a href="taoensso.timbre.cljs.html#var-logging-enabled.3F">logging-enabled?</a> </li><li> <a href="taoensso.timbre.cljs.html#var-logp">logp</a> </li><li> <a href="taoensso.timbre.cljs.html#var-logp">logp</a> </li><li> <a href="taoensso.timbre.cljs.html#var-may-log.3F">may-log?</a> </li><li> <a href="taoensso.timbre.cljs.html#var-merge-config.21">merge-config!</a> </li><li> <a href="taoensso.timbre.cljs.html#var-ordered-levels">ordered-levels</a> </li><li> <a href="taoensso.timbre.cljs.html#var-println-appender">println-appender</a> </li><li> <a href="taoensso.timbre.cljs.html#var-report">report</a> </li><li> <a href="taoensso.timbre.cljs.html#var-report">report</a> </li><li> <a href="taoensso.timbre.cljs.html#var-reportf">reportf</a> </li><li> <a href="taoensso.timbre.cljs.html#var-reportf">reportf</a> </li><li> <a href="taoensso.timbre.cljs.html#var-set-config.21">set-config!</a> </li><li> <a href="taoensso.timbre.cljs.html#var-set-level.21">set-level!</a> </li><li> <a href="taoensso.timbre.cljs.html#var-set-min-level">set-min-level</a> </li><li> <a href="taoensso.timbre.cljs.html#var-set-min-level.21">set-min-level!</a> </li><li> <a href="taoensso.timbre.cljs.html#var-set-ns-min-level">set-ns-min-level</a> </li><li> <a href="taoensso.timbre.cljs.html#var-set-ns-min-level.21">set-ns-min-level!</a> </li><li> <a href="taoensso.timbre.cljs.html#var-set-ns-min-level.21">set-ns-min-level!</a> </li><li> <a href="taoensso.timbre.cljs.html#var-shutdown-appenders.21">shutdown-appenders!</a> </li><li> <a href="taoensso.timbre.cljs.html#var-sometimes">sometimes</a> </li><li> <a href="taoensso.timbre.cljs.html#var-sometimes">sometimes</a> </li><li> <a href="taoensso.timbre.cljs.html#var-spy">spy</a> </li><li> <a href="taoensso.timbre.cljs.html#var-spy">spy</a> </li><li> <a href="taoensso.timbre.cljs.html#var-stacktrace">stacktrace</a> </li><li> <a href="taoensso.timbre.cljs.html#var-str-println">str-println</a> </li><li> <a href="taoensso.timbre.cljs.html#var-swap-config.21">swap-config!</a> </li><li> <a href="taoensso.timbre.cljs.html#var-trace">trace</a> </li><li> <a href="taoensso.timbre.cljs.html#var-trace">trace</a> </li><li> <a href="taoensso.timbre.cljs.html#var-tracef">tracef</a> </li><li> <a href="taoensso.timbre.cljs.html#var-tracef">tracef</a> </li><li> <a href="taoensso.timbre.cljs.html#var-warn">warn</a> </li><li> <a href="taoensso.timbre.cljs.html#var-warn">warn</a> </li><li> <a href="taoensso.timbre.cljs.html#var-warnf">warnf</a> </li><li> <a href="taoensso.timbre.cljs.html#var-warnf">warnf</a> </li><li> <a href="taoensso.timbre.cljs.html#var-with-config">with-config</a> </li><li> <a href="taoensso.timbre.cljs.html#var-with-config">with-config</a> </li><li> <a href="taoensso.timbre.cljs.html#var-with-context">with-context</a> </li><li> <a href="taoensso.timbre.cljs.html#var-with-context">with-context</a> </li><li> <a href="taoensso.timbre.cljs.html#var-with-context.2B">with-context+</a> </li><li> <a href="taoensso.timbre.cljs.html#var-with-context.2B">with-context+</a> </li><li> <a href="taoensso.timbre.cljs.html#var-with-default-outs">with-default-outs</a> </li><li> <a href="taoensso.timbre.cljs.html#var-with-default-outs">with-default-outs</a> </li><li> <a href="taoensso.timbre.cljs.html#var-with-level">with-level</a> </li><li> <a href="taoensso.timbre.cljs.html#var-with-level">with-level</a> </li><li> <a href="taoensso.timbre.cljs.html#var-with-log-level">with-log-level</a> </li><li> <a href="taoensso.timbre.cljs.html#var-with-log-level">with-log-level</a> </li><li> <a href="taoensso.timbre.cljs.html#var-with-logging-config">with-logging-config</a> </li><li> <a href="taoensso.timbre.cljs.html#var-with-logging-config">with-logging-config</a> </li><li> <a href="taoensso.timbre.cljs.html#var-with-merged-config">with-merged-config</a> </li><li> <a href="taoensso.timbre.cljs.html#var-with-merged-config">with-merged-config</a> </li><li> <a href="taoensso.timbre.cljs.html#var-with-min-level">with-min-level</a> </li><li> <a href="taoensso.timbre.cljs.html#var-with-min-level">with-min-level</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.timbre.appenders.community.node-spit.cljs.html">taoensso.timbre.appenders.community.node-spit</a></h3><div class="doc"><pre class="plaintext">Requires <a href="https://github.com/pkpkpk/cljs-node-io">https://github.com/pkpkpk/cljs-node-io</a>.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.timbre.appenders.community.node-spit.cljs.html#var-node-spit-appender">node-spit-appender</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.timbre.appenders.core.cljs.html">taoensso.timbre.appenders.core</a></h3><div class="doc"><pre class="plaintext">Core Timbre appenders without any special dependency requirements.
These can be aliased into the main Timbre ns for convenience.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.timbre.appenders.core.cljs.html#var-console-.3Fappender">console-?appender</a> </li><li> <a href="taoensso.timbre.appenders.core.cljs.html#var-console-appender">console-appender</a> </li><li> <a href="taoensso.timbre.appenders.core.cljs.html#var-println-appender">println-appender</a> </li></ul></div></div></div></body></html>
Loading

0 comments on commit 481e098

Please sign in to comment.