Skip to content

Commit 3634897

Browse files
vemvvemv
committed
Update site docs
1 parent 74fc213 commit 3634897

File tree

10 files changed

+776
-740
lines changed

10 files changed

+776
-740
lines changed

‎docs/cider-nrepl/compatibility.html

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ <h2 id="java"><a class="anchor" href="#java"></a>Java</h2>
232232
<h2 id="clojure"><a class="anchor" href="#clojure"></a>Clojure</h2>
233233
<div class="sectionbody">
234234
<div class="paragraph">
235-
<p><code>cider-nrepl</code> targets Clojure 1.8+. As Clojure doesn&#8217;t have the concept of supported releases
235+
<p><code>cider-nrepl</code> targets Clojure 1.9+. As Clojure doesn&#8217;t have the concept of supported releases
236236
we have to get a bit creative to determine the minimum version to target.</p>
237237
</div>
238238
<div class="paragraph">
@@ -356,6 +356,18 @@ <h2 id="compatibility-matrix"><a class="anchor" href="#compatibility-matrix"></a
356356
<td class="tableblock halign-left valign-top"><p class="tableblock">1.8</p></td>
357357
<td class="tableblock halign-left valign-top"><p class="tableblock">0.6</p></td>
358358
</tr>
359+
<tr>
360+
<td class="tableblock halign-left valign-top"><p class="tableblock">0.44.0</p></td>
361+
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
362+
<td class="tableblock halign-left valign-top"><p class="tableblock">1.9</p></td>
363+
<td class="tableblock halign-left valign-top"><p class="tableblock">1.0.0</p></td>
364+
</tr>
365+
<tr>
366+
<td class="tableblock halign-left valign-top"><p class="tableblock">0.45.0</p></td>
367+
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
368+
<td class="tableblock halign-left valign-top"><p class="tableblock">1.9</p></td>
369+
<td class="tableblock halign-left valign-top"><p class="tableblock">1.0.0</p></td>
370+
</tr>
359371
</tbody>
360372
</table>
361373
</div>

‎docs/cider-nrepl/usage.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ <h1 class="page">Usage</h1>
221221
<h2 id="prerequisites"><a class="anchor" href="#prerequisites"></a>Prerequisites</h2>
222222
<div class="sectionbody">
223223
<div class="paragraph">
224-
<p><code>cider-nrepl</code> supports only Clojure(Script) 1.8+ and Java 8+.</p>
224+
<p><code>cider-nrepl</code> supports only Clojure(Script) 1.9+ and Java 8+.</p>
225225
</div>
226226
<div class="paragraph">
227227
<p>Leiningen users will need to have version 2.8.3 or newer installed.
@@ -239,15 +239,15 @@ <h2 id="via-leiningen"><a class="anchor" href="#via-leiningen"></a>Via Leiningen
239239
</div>
240240
<div class="listingblock">
241241
<div class="content">
242-
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">:plugins [[cider/cider-nrepl "0.44.0"]]</code></pre>
242+
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">:plugins [[cider/cider-nrepl "0.45.0"]]</code></pre>
243243
</div>
244244
</div>
245245
<div class="paragraph">
246246
<p>A minimal <code>profiles.clj</code> for CIDER would be:</p>
247247
</div>
248248
<div class="listingblock">
249249
<div class="content">
250-
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">{:user {:plugins [[cider/cider-nrepl "0.44.0"]]}}</code></pre>
250+
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">{:user {:plugins [[cider/cider-nrepl "0.45.0"]]}}</code></pre>
251251
</div>
252252
</div>
253253
<div class="paragraph">
@@ -257,7 +257,7 @@ <h2 id="via-leiningen"><a class="anchor" href="#via-leiningen"></a>Via Leiningen
257257
</div>
258258
<div class="listingblock">
259259
<div class="content">
260-
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">:dependencies [[cider/cider-nrepl "0.44.0"]]
260+
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">:dependencies [[cider/cider-nrepl "0.45.0"]]
261261
:repl-options {:nrepl-middleware
262262
[cider.nrepl/wrap-apropos
263263
cider.nrepl/wrap-classpath
@@ -293,7 +293,7 @@ <h3 id="via-boot"><a class="anchor" href="#via-boot"></a>Via Boot</h3>
293293
</div>
294294
<div class="listingblock">
295295
<div class="content">
296-
<pre>boot -d nrepl:1.0.0 -d cider/cider-nrepl:0.44.0 -i "(require 'cider.tasks)" cider.tasks/add-middleware -m cider.nrepl.middleware.apropos/wrap-apropos -m cider.nrepl.middleware.version/wrap-version repl --server wait</pre>
296+
<pre>boot -d nrepl:1.0.0 -d cider/cider-nrepl:0.45.0 -i "(require 'cider.tasks)" cider.tasks/add-middleware -m cider.nrepl.middleware.apropos/wrap-apropos -m cider.nrepl.middleware.version/wrap-version repl --server wait</pre>
297297
</div>
298298
</div>
299299
<div class="paragraph">
@@ -302,7 +302,7 @@ <h3 id="via-boot"><a class="anchor" href="#via-boot"></a>Via Boot</h3>
302302
<div class="listingblock">
303303
<div class="content">
304304
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">(set-env! :dependencies '[[nrepl "1.0.0"]
305-
[cider/cider-nrepl "0.44.0"]])
305+
[cider/cider-nrepl "0.45.0"]])
306306

307307
(require '[cider.tasks :refer [add-middleware]])
308308

@@ -343,7 +343,7 @@ <h2 id="via-clj"><a class="anchor" href="#via-clj"></a>Via clj</h2>
343343
</div>
344344
<div class="listingblock">
345345
<div class="content">
346-
<pre>clj -Sdeps '{:deps {cider/cider-nrepl {:mvn/version "0.44.0"} }}' -m nrepl.cmdline --middleware "[cider.nrepl/cider-middleware]"</pre>
346+
<pre>clj -Sdeps '{:deps {cider/cider-nrepl {:mvn/version "0.45.0"} }}' -M -m nrepl.cmdline --middleware "[cider.nrepl/cider-middleware]"</pre>
347347
</div>
348348
</div>
349349
<div class="paragraph">
@@ -354,12 +354,12 @@ <h2 id="via-clj"><a class="anchor" href="#via-clj"></a>Via clj</h2>
354354
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">{...
355355
:aliases
356356
{:cider-clj {:extra-deps {org.clojure/clojure {:mvn/version "1.10.1"}
357-
cider/cider-nrepl {:mvn/version "0.44.0"}}
357+
cider/cider-nrepl {:mvn/version "0.45.0"}}
358358
:main-opts ["-m" "nrepl.cmdline" "--middleware" "[cider.nrepl/cider-middleware]"]}
359359

360360
:cider-cljs {:extra-deps {org.clojure/clojure {:mvn/version "1.10.1"}
361361
org.clojure/clojurescript {:mvn/version "1.10.339"}
362-
cider/cider-nrepl {:mvn/version "0.44.0"}
362+
cider/cider-nrepl {:mvn/version "0.45.0"}
363363
cider/piggieback {:mvn/version "0.5.2"}}
364364
:main-opts ["-m" "nrepl.cmdline" "--middleware"
365365
"[cider.nrepl/cider-middleware,cider.piggieback/wrap-cljs-repl]"]}}}</code></pre>
@@ -370,7 +370,7 @@ <h2 id="via-clj"><a class="anchor" href="#via-clj"></a>Via clj</h2>
370370
</div>
371371
<div class="listingblock">
372372
<div class="content">
373-
<pre>clj -A:cider-clj</pre>
373+
<pre>clj -M:cider-clj</pre>
374374
</div>
375375
</div>
376376
</div>

‎docs/cider/about/compatibility.html

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -676,7 +676,15 @@ <h2 id="compatibility-matrix"><a class="anchor" href="#compatibility-matrix"></a
676676
<td class="tableblock halign-left valign-top"><p class="tableblock">1.0</p></td>
677677
<td class="tableblock halign-left valign-top"><p class="tableblock">0.44</p></td>
678678
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
679-
<td class="tableblock halign-left valign-top"><p class="tableblock">1.8</p></td>
679+
<td class="tableblock halign-left valign-top"><p class="tableblock">1.9</p></td>
680+
</tr>
681+
<tr>
682+
<td class="tableblock halign-left valign-top"><p class="tableblock">1.13</p></td>
683+
<td class="tableblock halign-left valign-top"><p class="tableblock">26.1</p></td>
684+
<td class="tableblock halign-left valign-top"><p class="tableblock">1.0</p></td>
685+
<td class="tableblock halign-left valign-top"><p class="tableblock">0.44</p></td>
686+
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
687+
<td class="tableblock halign-left valign-top"><p class="tableblock">1.9</p></td>
680688
</tr>
681689
</tbody>
682690
</table>

‎docs/cider/basics/middleware_setup.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -482,15 +482,15 @@ <h3 id="using-leiningen"><a class="anchor" href="#using-leiningen"></a>Using Lei
482482
</div>
483483
<div class="listingblock">
484484
<div class="content">
485-
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">:plugins [[cider/cider-nrepl "0.44.0"]]</code></pre>
485+
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">:plugins [[cider/cider-nrepl "0.45.0"]]</code></pre>
486486
</div>
487487
</div>
488488
<div class="paragraph">
489489
<p>A minimal <code>profiles.clj</code> for CIDER would be:</p>
490490
</div>
491491
<div class="listingblock">
492492
<div class="content">
493-
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">{:repl {:plugins [[cider/cider-nrepl "0.44.0"]]}}</code></pre>
493+
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">{:repl {:plugins [[cider/cider-nrepl "0.45.0"]]}}</code></pre>
494494
</div>
495495
</div>
496496
<div class="admonitionblock warning">
@@ -532,7 +532,7 @@ <h3 id="using-boot"><a class="anchor" href="#using-boot"></a>Using Boot</h3>
532532
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">(require 'boot.repl)
533533

534534
(swap! boot.repl/*default-dependencies*
535-
concat '[[cider/cider-nrepl "0.44.0"]])
535+
concat '[[cider/cider-nrepl "0.45.0"]])
536536

537537
(swap! boot.repl/*default-middleware*
538538
conj 'cider.nrepl/cider-middleware)</code></pre>
@@ -552,11 +552,11 @@ <h3 id="using-tools-deps"><a class="anchor" href="#using-tools-deps"></a>Using t
552552
</div>
553553
<div class="listingblock">
554554
<div class="content">
555-
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure"> :cider-clj {:extra-deps {cider/cider-nrepl {:mvn/version "0.44.0"}}
555+
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure"> :cider-clj {:extra-deps {cider/cider-nrepl {:mvn/version "0.45.0"}}
556556
:main-opts ["-m" "nrepl.cmdline" "--middleware" "[cider.nrepl/cider-middleware]"]}
557557

558558
:cider-cljs {:extra-deps {org.clojure/clojurescript {:mvn/version "1.10.339"}
559-
cider/cider-nrepl {:mvn/version "0.44.0"}
559+
cider/cider-nrepl {:mvn/version "0.45.0"}
560560
cider/piggieback {:mvn/version "0.5.3"}}
561561
:main-opts ["-m" "nrepl.cmdline" "--middleware"
562562
"[cider.nrepl/cider-middleware,cider.piggieback/wrap-cljs-repl]"]}</code></pre>
@@ -596,7 +596,7 @@ <h3 id="using-gradle"><a class="anchor" href="#using-gradle"></a>Using Gradle</h
596596
<div class="content">
597597
<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">dependencies {
598598
devImplementation 'nrepl:nrepl:0.9.0'
599-
devImplementation 'cider:cider-nrepl:0.44.0'
599+
devImplementation 'cider:cider-nrepl:0.45.0'
600600
}
601601

602602
tasks.named('clojureRepl') {

‎docs/cider/basics/up_and_running.html

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -525,6 +525,22 @@ <h2 id="launch-an-nrepl-server-from-emacs"><a class="anchor" href="#launch-an-nr
525525
(cider-preferred-build-tool . lein)))</code></pre>
526526
</div>
527527
</div>
528+
<div class="admonitionblock note">
529+
<table>
530+
<tr>
531+
<td class="icon">
532+
<i class="fa icon-note" title="Note"></i>
533+
</td>
534+
<td class="content">
535+
<code>cider-jack-in</code> is mainly designed for local development (with files on a
536+
local machine and the nREPL process running on the same machine). It does support
537+
various common remote/container scenarios, as documented later in this section. Due
538+
to the large variation of remote scenarios it cannot support all of them, so in
539+
some cases a manual nREPL start and usage of <code>cider-connect</code> might be a better option.
540+
</td>
541+
</tr>
542+
</table>
543+
</div>
528544
<div class="sect2">
529545
<h3 id="auto-injecting-dependencies"><a class="anchor" href="#auto-injecting-dependencies"></a>Auto-Injecting Dependencies</h3>
530546
<div class="paragraph">
@@ -544,7 +560,7 @@ <h3 id="auto-injecting-dependencies"><a class="anchor" href="#auto-injecting-dep
544560
</div>
545561
<div class="literalblock">
546562
<div class="content">
547-
<pre>$ clojure -Sdeps '{:deps {nrepl {:mvn/version "0.6.0"} cider/cider-nrepl {:mvn/version "0.44.0"}}}' -m nrepl.cmdline --middleware '["cider.nrepl/cider-middleware"]'</pre>
563+
<pre>$ clojure -Sdeps '{:deps {nrepl {:mvn/version "0.6.0"} cider/cider-nrepl {:mvn/version "0.45.0"}}}' -m nrepl.cmdline --middleware '["cider.nrepl/cider-middleware"]'</pre>
548564
</div>
549565
</div>
550566
<div class="admonitionblock tip">
@@ -957,7 +973,7 @@ <h2 id="connect-to-a-running-nrepl-server"><a class="anchor" href="#connect-to-a
957973
</div>
958974
<div class="listingblock">
959975
<div class="content">
960-
<pre class="highlightjs highlight"><code class="language-sh hljs" data-lang="sh">$ clj -Sdeps '{:deps {cider/cider-nrepl {:mvn/version "0.44.0"}}}' -m nrepl.cmdline --middleware "[cider.nrepl/cider-middleware]"</code></pre>
976+
<pre class="highlightjs highlight"><code class="language-sh hljs" data-lang="sh">$ clj -Sdeps '{:deps {cider/cider-nrepl {:mvn/version "0.45.0"}}}' -m nrepl.cmdline --middleware "[cider.nrepl/cider-middleware]"</code></pre>
961977
</div>
962978
</div>
963979
<div class="paragraph">

‎docs/cider/cljs/shadow-cljs.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -526,7 +526,7 @@ <h3 id="using-cider-connect-cljs"><a class="anchor" href="#using-cider-connect-c
526526
</div>
527527
<div class="listingblock">
528528
<div class="content">
529-
<pre class="highlightjs highlight"><code class="language-clj hljs" data-lang="clj"> :dependencies [[cider/cider-nrepl "0.44.0"] ;; mandatory (unless it's inherited from deps.edn or otherwise present in the classpath of shadow-cljs's JVM process)
529+
<pre class="highlightjs highlight"><code class="language-clj hljs" data-lang="clj"> :dependencies [[cider/cider-nrepl "0.45.0"] ;; mandatory (unless it's inherited from deps.edn or otherwise present in the classpath of shadow-cljs's JVM process)
530530
[refactor-nrepl/refactor-nrepl "3.9.0"]] ;; refactor-nrepl is optional
531531

532532
:nrepl {:middleware [cider.nrepl/cider-middleware ;; it's advisable to explicitly add this middleware. It's automatically added by shadow-cljs (if available in the classpath), unless `:nrepl {:cider false}`

‎docs/cider/cljs/up_and_running.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ <h3 id="manual-piggieback-setup"><a class="anchor" href="#manual-piggieback-setu
483483
<div class="content">
484484
<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">dependencies {
485485
devImplementation 'nrepl:nrepl:0.9.0'
486-
devImplementation 'cider:cider-nrepl:0.44.0'
486+
devImplementation 'cider:cider-nrepl:0.45.0'
487487
devImplementation 'cider:cider-piggieback:0.5.3'
488488
}
489489

‎docs/cider/debugging/logging.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -739,6 +739,9 @@ <h2 id="log-framework"><a class="anchor" href="#log-framework"></a>Log framework
739739
<li>
740740
<p><a href="https://logback.qos.ch">Logback</a></p>
741741
</li>
742+
<li>
743+
<p><a href="https://github.com/taoensso/timbre">Timbre</a></p>
744+
</li>
742745
</ul>
743746
</div>
744747
<div class="paragraph">
@@ -749,9 +752,6 @@ <h2 id="log-framework"><a class="anchor" href="#log-framework"></a>Log framework
749752
configuration changes made at runtime, which are wiped out by the
750753
Log4j2 reconfiguration mechanism.</p>
751754
</div>
752-
<div class="paragraph">
753-
<p>Timbre support is WIP as well.</p>
754-
</div>
755755
<div class="admonitionblock tip">
756756
<table>
757757
<tr>

0 commit comments

Comments
 (0)