Skip to content

Commit 8c2e9b7

Browse files
oubiwannoubiwann
committed
Added placeholder generated docs.
1 parent 1734a85 commit 8c2e9b7

File tree

8 files changed

+858
-1
lines changed

8 files changed

+858
-1
lines changed

‎docs/current/css/default.css‎

Lines changed: 622 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/current/highlight/highlight.min.js‎

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/current/highlight/solarized-light.css‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
/*
2+
3+
Orginal Style from ethanschoonover.com/solarized (c) Jeremy Hull <[email protected]>
4+
5+
*/
6+
7+
.hljs {
8+
display: block;
9+
overflow-x: auto;
10+
padding: 0.5em;
11+
background: #fdf6e3;
12+
color: #657b83;
13+
}
14+
15+
.hljs-comment,
16+
.hljs-quote {
17+
color: #93a1a1;
18+
}
19+
20+
/* Solarized Green */
21+
.hljs-keyword,
22+
.hljs-selector-tag,
23+
.hljs-addition {
24+
color: #859900;
25+
}
26+
27+
/* Solarized Cyan */
28+
.hljs-number,
29+
.hljs-string,
30+
.hljs-meta .hljs-meta-string,
31+
.hljs-literal,
32+
.hljs-doctag,
33+
.hljs-regexp {
34+
color: #2aa198;
35+
}
36+
37+
/* Solarized Blue */
38+
.hljs-title,
39+
.hljs-section,
40+
.hljs-name,
41+
.hljs-selector-id,
42+
.hljs-selector-class {
43+
color: #268bd2;
44+
}
45+
46+
/* Solarized Yellow */
47+
.hljs-attribute,
48+
.hljs-attr,
49+
.hljs-variable,
50+
.hljs-template-variable,
51+
.hljs-class .hljs-title,
52+
.hljs-type {
53+
color: #b58900;
54+
}
55+
56+
/* Solarized Orange */
57+
.hljs-symbol,
58+
.hljs-bullet,
59+
.hljs-subst,
60+
.hljs-meta,
61+
.hljs-meta .hljs-keyword,
62+
.hljs-selector-attr,
63+
.hljs-selector-pseudo,
64+
.hljs-link {
65+
color: #cb4b16;
66+
}
67+
68+
/* Solarized Red */
69+
.hljs-built_in,
70+
.hljs-deletion {
71+
color: #dc322f;
72+
}
73+
74+
.hljs-formula {
75+
background: #eee8d5;
76+
}
77+
78+
.hljs-emphasis {
79+
font-style: italic;
80+
}
81+
82+
.hljs-strong {
83+
font-weight: bold;
84+
}

‎docs/current/index.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<!DOCTYPE html PUBLIC ""
2+
"">
3+
<html><head><meta charset="UTF-8" /><title>ring-redis-session 3.1.0-SNAPSHOT</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="highlight/solarized-light.css" /><script type="text/javascript" src="highlight/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> with <a href="https://github.com/xsc/codox-theme-rdash">RDash UI</a> theme</h2><h1><a href="index.html"><span class="project-title"><span class="project-name">ring-redis-session</span> <span class="project-version">3.1.0-SNAPSHOT</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">Namespaces</span></h3><ul></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">ring-redis-session</span> <span class="project-version">3.1.0-SNAPSHOT</span></span></h1><h5 class="license">Released under the <a href="https://opensource.org/licenses/EPL-1.0">Eclipse Public License</a></h5><div class="doc"><p>Redis-backed Clojure/Ring session store.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[clojusc/ring-redis-session "3.1.0-SNAPSHOT"]</pre><h2>Namespaces</h2></div></body></html>

‎docs/current/js/jquery.min.js‎

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/current/js/page_effects.js‎

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
function visibleInParent(element) {
2+
var position = $(element).position().top
3+
return position > -50 && position < ($(element).offsetParent().height() - 50)
4+
}
5+
6+
function hasFragment(link, fragment) {
7+
return $(link).attr("href").indexOf("#" + fragment) != -1
8+
}
9+
10+
function findLinkByFragment(elements, fragment) {
11+
return $(elements).filter(function(i, e) { return hasFragment(e, fragment)}).first()
12+
}
13+
14+
function scrollToCurrentVarLink(elements) {
15+
var elements = $(elements);
16+
var parent = elements.offsetParent();
17+
18+
if (elements.length == 0) return;
19+
20+
var top = elements.first().position().top;
21+
var bottom = elements.last().position().top + elements.last().height();
22+
23+
if (top >= 0 && bottom <= parent.height()) return;
24+
25+
if (top < 0) {
26+
parent.scrollTop(parent.scrollTop() + top);
27+
}
28+
else if (bottom > parent.height()) {
29+
parent.scrollTop(parent.scrollTop() + bottom - parent.height());
30+
}
31+
}
32+
33+
function setCurrentVarLink() {
34+
$('.secondary a').parent().removeClass('current')
35+
$('.anchor').
36+
filter(function(index) { return visibleInParent(this) }).
37+
each(function(index, element) {
38+
findLinkByFragment(".secondary a", element.id).
39+
parent().
40+
addClass('current')
41+
});
42+
scrollToCurrentVarLink('.secondary .current');
43+
}
44+
45+
var hasStorage = (function() { try { return localStorage.getItem } catch(e) {} }())
46+
47+
function scrollPositionId(element) {
48+
var directory = window.location.href.replace(/[^\/]+\.html$/, '')
49+
return 'scroll::' + $(element).attr('id') + '::' + directory
50+
}
51+
52+
function storeScrollPosition(element) {
53+
if (!hasStorage) return;
54+
localStorage.setItem(scrollPositionId(element) + "::x", $(element).scrollLeft())
55+
localStorage.setItem(scrollPositionId(element) + "::y", $(element).scrollTop())
56+
}
57+
58+
function recallScrollPosition(element) {
59+
if (!hasStorage) return;
60+
$(element).scrollLeft(localStorage.getItem(scrollPositionId(element) + "::x"))
61+
$(element).scrollTop(localStorage.getItem(scrollPositionId(element) + "::y"))
62+
}
63+
64+
function persistScrollPosition(element) {
65+
recallScrollPosition(element)
66+
$(element).scroll(function() { storeScrollPosition(element) })
67+
}
68+
69+
function sidebarContentWidth(element) {
70+
var widths = $(element).find('.inner').map(function() { return $(this).innerWidth() })
71+
return Math.max.apply(Math, widths)
72+
}
73+
74+
function calculateSize(width, snap, margin, minimum) {
75+
if (width == 0) {
76+
return 0
77+
}
78+
else {
79+
return Math.max(minimum, (Math.ceil(width / snap) * snap) + (margin * 2))
80+
}
81+
}
82+
83+
function resizeSidebars() {
84+
var primaryWidth = sidebarContentWidth('.primary')
85+
var secondaryWidth = 0
86+
87+
if ($('.secondary').length != 0) {
88+
secondaryWidth = sidebarContentWidth('.secondary')
89+
}
90+
91+
// snap to grid
92+
primaryWidth = calculateSize(primaryWidth, 32, 13, 160)
93+
secondaryWidth = calculateSize(secondaryWidth, 32, 13, 160)
94+
95+
$('.primary').css('width', primaryWidth)
96+
$('.secondary').css('width', secondaryWidth).css('left', primaryWidth + 1)
97+
98+
if (secondaryWidth > 0) {
99+
$('#content').css('left', primaryWidth + secondaryWidth + 2)
100+
}
101+
else {
102+
$('#content').css('left', primaryWidth + 1)
103+
}
104+
}
105+
106+
$(window).ready(resizeSidebars)
107+
$(window).ready(setCurrentVarLink)
108+
$(window).ready(function() { persistScrollPosition('.primary')})
109+
$(window).ready(function() {
110+
$('#content').scroll(setCurrentVarLink)
111+
$(window).resize(setCurrentVarLink)
112+
$(window).resize(resizeSidebars)
113+
})

‎docs/index.html‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<meta http-equiv="refresh" content="0; url=http://clojusc.github.io/ring-redis-session/current/">
2+
<link rel="canonical" href="http://clojusc.github.io/ring-redis-session/current/" />

‎project.clj‎

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,18 @@
1111
:profiles {
1212
:uber {
1313
:aot :all}
14+
:dev {
15+
:source-paths ["dev-resources/src"]
16+
:repl-options {
17+
:init-ns ring.redis.session.dev}}
18+
:test {
19+
:exclusions [org.clojure/clojure]
20+
:plugins
21+
[[lein-ancient "0.6.10"]
22+
[jonase/eastwood "0.2.3"]
23+
[lein-bikeshed "0.4.1"]
24+
[lein-kibit "0.1.3"]
25+
[venantius/yagni "0.1.4"]]}
1426
:1.5 {
1527
:dependencies [
1628
[org.clojure/clojure "1.5.0"]
@@ -24,4 +36,19 @@
2436
:1.8 {
2537
:dependencies [[org.clojure/clojure "1.8.0"]]}
2638
:1.9 {
27-
:dependencies [[org.clojure/clojure "1.9.0-alpha14"]]}})
39+
:dependencies [[org.clojure/clojure "1.9.0-alpha14"]]}
40+
:docs {
41+
:dependencies [[codox-theme-rdash "0.1.1"]]
42+
:plugins [[lein-codox "0.10.3"]
43+
[lein-simpleton "1.3.0"]]
44+
:codox {
45+
:project {
46+
:name "ring-redis-session"
47+
:description "Redis-backed Clojure/Ring session store"}
48+
:namespaces [#"^ring.redis.session\.(?!dev)"]
49+
:themes [:rdash]
50+
:output-path "docs/current"
51+
:doc-paths ["resources/docs"]
52+
:metadata {
53+
:doc/format :markdown
54+
:doc "Documentation forthcoming"}}}})

0 commit comments

Comments
 (0)