Skip to content

Commit

Permalink
Update site docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vemv committed Nov 4, 2023
1 parent 105e661 commit a2d7e84
Show file tree
Hide file tree
Showing 8 changed files with 772 additions and 727 deletions.
12 changes: 6 additions & 6 deletions docs/cider/basics/middleware_setup.html
Original file line number Diff line number Diff line change
Expand Up @@ -481,15 +481,15 @@ <h3 id="using-leiningen"><a class="anchor" href="#using-leiningen"></a>Using Lei
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">:plugins [[cider/cider-nrepl "0.42.1"]]</code></pre>
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">:plugins [[cider/cider-nrepl "0.43.0"]]</code></pre>
</div>
</div>
<div class="paragraph">
<p>A minimal <code>profiles.clj</code> for CIDER would be:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">{:repl {:plugins [[cider/cider-nrepl "0.42.1"]]}}</code></pre>
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">{:repl {:plugins [[cider/cider-nrepl "0.43.0"]]}}</code></pre>
</div>
</div>
<div class="admonitionblock warning">
Expand Down Expand Up @@ -531,7 +531,7 @@ <h3 id="using-boot"><a class="anchor" href="#using-boot"></a>Using Boot</h3>
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">(require 'boot.repl)

(swap! boot.repl/*default-dependencies*
concat '[[cider/cider-nrepl "0.42.1"]])
concat '[[cider/cider-nrepl "0.43.0"]])

(swap! boot.repl/*default-middleware*
conj 'cider.nrepl/cider-middleware)</code></pre>
Expand All @@ -551,11 +551,11 @@ <h3 id="using-tools-deps"><a class="anchor" href="#using-tools-deps"></a>Using t
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure"> :cider-clj {:extra-deps {cider/cider-nrepl {:mvn/version "0.42.1"}}
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure"> :cider-clj {:extra-deps {cider/cider-nrepl {:mvn/version "0.43.0"}}
:main-opts ["-m" "nrepl.cmdline" "--middleware" "[cider.nrepl/cider-middleware]"]}

:cider-cljs {:extra-deps {org.clojure/clojurescript {:mvn/version "1.10.339"}
cider/cider-nrepl {:mvn/version "0.42.1"}
cider/cider-nrepl {:mvn/version "0.43.0"}
cider/piggieback {:mvn/version "0.5.3"}}
:main-opts ["-m" "nrepl.cmdline" "--middleware"
"[cider.nrepl/cider-middleware,cider.piggieback/wrap-cljs-repl]"]}</code></pre>
Expand Down Expand Up @@ -595,7 +595,7 @@ <h3 id="using-gradle"><a class="anchor" href="#using-gradle"></a>Using Gradle</h
<div class="content">
<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">dependencies {
devImplementation 'nrepl:nrepl:0.9.0'
devImplementation 'cider:cider-nrepl:0.42.1'
devImplementation 'cider:cider-nrepl:0.43.0'
}

tasks.named('clojureRepl') {
Expand Down
4 changes: 2 additions & 2 deletions docs/cider/basics/up_and_running.html
Original file line number Diff line number Diff line change
Expand Up @@ -543,7 +543,7 @@ <h3 id="auto-injecting-dependencies"><a class="anchor" href="#auto-injecting-dep
</div>
<div class="literalblock">
<div class="content">
<pre>$ clojure -Sdeps '{:deps {nrepl {:mvn/version "0.6.0"} cider/cider-nrepl {:mvn/version "0.42.1"}}}' -m nrepl.cmdline --middleware '["cider.nrepl/cider-middleware"]'</pre>
<pre>$ clojure -Sdeps '{:deps {nrepl {:mvn/version "0.6.0"} cider/cider-nrepl {:mvn/version "0.43.0"}}}' -m nrepl.cmdline --middleware '["cider.nrepl/cider-middleware"]'</pre>
</div>
</div>
<div class="admonitionblock tip">
Expand Down Expand Up @@ -939,7 +939,7 @@ <h2 id="connect-to-a-running-nrepl-server"><a class="anchor" href="#connect-to-a
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-sh hljs" data-lang="sh">$ clj -Sdeps '{:deps {cider/cider-nrepl {:mvn/version "0.42.1"}}}' -m nrepl.cmdline --middleware "[cider.nrepl/cider-middleware]"</code></pre>
<pre class="highlightjs highlight"><code class="language-sh hljs" data-lang="sh">$ clj -Sdeps '{:deps {cider/cider-nrepl {:mvn/version "0.43.0"}}}' -m nrepl.cmdline --middleware "[cider.nrepl/cider-middleware]"</code></pre>
</div>
</div>
<div class="paragraph">
Expand Down
2 changes: 1 addition & 1 deletion docs/cider/cljs/shadow-cljs.html
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,7 @@ <h3 id="using-cider-connect-cljs"><a class="anchor" href="#using-cider-connect-c
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-clj hljs" data-lang="clj"> :dependencies [[cider/cider-nrepl "0.42.1"] ;; mandatory (unless it's inherited from deps.edn or otherwise present in the classpath of shadow-cljs's JVM process)
<pre class="highlightjs highlight"><code class="language-clj hljs" data-lang="clj"> :dependencies [[cider/cider-nrepl "0.43.0"] ;; mandatory (unless it's inherited from deps.edn or otherwise present in the classpath of shadow-cljs's JVM process)
[refactor-nrepl/refactor-nrepl "3.9.0"]] ;; refactor-nrepl is optional

: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}`
Expand Down
2 changes: 1 addition & 1 deletion docs/cider/cljs/up_and_running.html
Original file line number Diff line number Diff line change
Expand Up @@ -482,7 +482,7 @@ <h3 id="manual-piggieback-setup"><a class="anchor" href="#manual-piggieback-setu
<div class="content">
<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">dependencies {
devImplementation 'nrepl:nrepl:0.9.0'
devImplementation 'cider:cider-nrepl:0.42.1'
devImplementation 'cider:cider-nrepl:0.43.0'
devImplementation 'cider:cider-piggieback:0.5.3'
}

Expand Down
13 changes: 11 additions & 2 deletions docs/cider/debugging/inspector.html
Original file line number Diff line number Diff line change
Expand Up @@ -509,12 +509,12 @@ <h2 id="usage"><a class="anchor" href="#usage"></a>Usage</h2>
<td class="tableblock halign-left valign-top"><p class="tableblock">Refresh the inspector (e.g. if viewing an atom/ref/agent)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><kbd>SPC</kbd></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><kbd>SPC</kbd> or <kbd>Next</kbd></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>cider-inspector-next-page</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Jump to next page in paginated view</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><kbd>M-SPC</kbd></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><kbd>M-SPC</kbd> or <kbd>Prev</kbd></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>cider-inspector-prev-page</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Jump to previous page in paginated view</p></td>
</tr>
Expand Down Expand Up @@ -558,6 +558,15 @@ <h2 id="usage"><a class="anchor" href="#usage"></a>Usage</h2>
</div>
</div>
<div class="sect1">
<h2 id="use-enrich-classpath-for-best-results"><a class="anchor" href="#use-enrich-classpath-for-best-results"></a>Use <code>enrich-classpath</code> for best results</h2>
<div class="sectionbody">
<div class="paragraph">
<p>If <a href="../config/basic_config.html#use-enrich-classpath" class="xref page">enrich-classpath</a> is activated, inspecting a Java class, method or field
will richly display its Java doc comment documentation at the bottom of the inspector.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="configuration"><a class="anchor" href="#configuration"></a>Configuration</h2>
<div class="sectionbody">
<div class="paragraph">
Expand Down
36 changes: 36 additions & 0 deletions docs/cider/usage/dealing_with_errors.html
Original file line number Diff line number Diff line change
Expand Up @@ -841,6 +841,42 @@ <h4 id="limitations"><a class="anchor" href="#limitations"></a>Limitations</h4>
</div>
</div>
</div>
<div class="sect1">
<h2 id="inspector-integration"><a class="anchor" href="#inspector-integration"></a>Inspector integration</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Within <code><strong>cider-error</strong></code>, when clicking directly a top-level exception (any of them in the cause chain),
that specific exception will be inspected with the CIDER <a href="../debugging/inspector.html" class="xref page">Inspector</a>.</p>
</div>
<div class="paragraph">
<p>This allows you to better understand intrincate <code>ex-data</code>.</p>
</div>
<div class="paragraph">
<p>This clicking is defined and customizable in <code>cider-stacktrace-exception-map</code>, which has the following defaults:</p>
</div>
<div class="sect2">
<h3 id="keybindings-2"><a class="anchor" href="#keybindings-2"></a>Keybindings</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Action</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><kbd>click</kbd> or <kbd>i</kbd> or <kbd>p</kbd></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Open the given exception in the Inspector.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<nav class="pagination">
<span class="prev"><a href="pretty_printing.html">Pretty Printing</a></span>
<span class="next"><a href="working_with_documentation.html">Working with Documentation</a></span>
Expand Down
Loading

0 comments on commit a2d7e84

Please sign in to comment.