Skip to content

Commit

Permalink
Update site docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@bbatsov
bbatsov committed Sep 19, 2024
1 parent 702d819 commit 85106c4
Show file tree
Hide file tree
Showing 11 changed files with 1,087 additions and 1,073 deletions.
2 changes: 1 addition & 1 deletion docs/_/css/site.css
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/_/js/site.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 1 addition & 7 deletions docs/cider-nrepl/compatibility.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -362,19 +362,13 @@ <h2 id="compatibility-matrix"><a class="anchor" href="#compatibility-matrix"></a
<td class="tableblock halign-left valign-top"><p class="tableblock">0.6</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">0.44.0</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1.9</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1.0.0</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">0.47.0</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1.9</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1.0.0</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">0.49.0</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">0.50.0</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1.10</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1.0.0</p></td>
Expand Down
23 changes: 22 additions & 1 deletion docs/cider-nrepl/nrepl-api/ops.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1156,6 +1156,9 @@ <h3 id="info"><a class="anchor" href="#info"></a><code>info</code></h3>
<div class="paragraph">
<p>Return a map of information about the specified symbol.</p>
</div>
<div class="paragraph">
<p>Note: Documentation may be incomplete; not all return keys are described.</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">Required parameters</dt>
Expand Down Expand Up @@ -1197,6 +1200,12 @@ <h3 id="info"><a class="anchor" href="#info"></a><code>info</code></h3>
<div class="ulist">
<ul>
<li>
<p><code>:arglists-str</code> The arguments list(s) accepted by the symbol, as a string, if applicable.</p>
</li>
<li>
<p><code>:column</code> The column number where the symbol is defined.</p>
</li>
<li>
<p><code>:doc-block-tags-fragments</code> May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
</li>
<li>
Expand All @@ -1206,6 +1215,18 @@ <h3 id="info"><a class="anchor" href="#info"></a><code>info</code></h3>
<p><code>:doc-fragments</code> May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
</li>
<li>
<p><code>:file</code> Either a URI or a relative path where the symbol is defined.</p>
</li>
<li>
<p><code>:line</code> The line number the symbol is defined.</p>
</li>
<li>
<p><code>:name</code> The unqualified name of the symbol.</p>
</li>
<li>
<p><code>:ns</code> The namespace the symbol belongs to.</p>
</li>
<li>
<p><code>:status</code> done</p>
</li>
</ul>
Expand Down Expand Up @@ -2173,7 +2194,7 @@ <h3 id="macroexpand"><a class="anchor" href="#macroexpand"></a><code>macroexpand
<p><code>:display-namespaces</code> How to print namespace-qualified symbols in the result. Possible values are "qualified" to leave all namespaces qualified, "none" to elide all namespaces, or "tidy" to replace namespaces with their aliases in the given namespace. Defaults to "qualified".</p>
</li>
<li>
<p><code>:expander</code> The macroexpansion function to use. Possible values are "macroexpand-1", "macroexpand", or "macroexpand-all". Defaults to "macroexpand".</p>
<p><code>:expander</code> The macroexpansion function to use. Possible values are "macroexpand-1", "macroexpand", "macroexpand-step", or "macroexpand-all". Defaults to "macroexpand".</p>
</li>
<li>
<p><code>:ns</code> The namespace in which to perform the macroexpansion. Defaults to 'user for Clojure and 'cljs.user for ClojureScript.</p>
Expand Down
17 changes: 8 additions & 9 deletions docs/cider-nrepl/usage.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -240,11 +240,10 @@ <h1 class="page">Usage</h1>
<h2 id="prerequisites"><a class="anchor" href="#prerequisites"></a>Prerequisites</h2>
<div class="sectionbody">
<div class="paragraph">
<p><code>cider-nrepl</code> supports only Clojure(Script) 1.9+ and Java 8+.</p>
<p><code>cider-nrepl</code> supports only Clojure(Script) 1.10+ and Java 8+.</p>
</div>
<div class="paragraph">
<p>Leiningen users will need to have version 2.8.3 or newer installed.
Boot users will need to have version 2.8.2 or newer installed.</p>
<p>Leiningen users will need to have version 2.8.3 or newer installed.</p>
</div>
</div>
</div>
Expand All @@ -258,15 +257,15 @@ <h2 id="via-leiningen"><a class="anchor" href="#via-leiningen"></a>Via Leiningen
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">:plugins [[cider/cider-nrepl "0.49.0"]]</code></pre>
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">:plugins [[cider/cider-nrepl "0.50.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">{:user {:plugins [[cider/cider-nrepl "0.49.0"]]}}</code></pre>
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">{:user {:plugins [[cider/cider-nrepl "0.50.0"]]}}</code></pre>
</div>
</div>
<div class="paragraph">
Expand All @@ -276,7 +275,7 @@ <h2 id="via-leiningen"><a class="anchor" href="#via-leiningen"></a>Via Leiningen
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">:dependencies [[cider/cider-nrepl "0.49.0"]]
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">:dependencies [[cider/cider-nrepl "0.50.0"]]
:repl-options {:nrepl-middleware
[cider.nrepl/wrap-apropos
cider.nrepl/wrap-classpath
Expand Down Expand Up @@ -314,7 +313,7 @@ <h2 id="via-clj"><a class="anchor" href="#via-clj"></a>Via clj</h2>
</div>
<div class="listingblock">
<div class="content">
<pre>clj -Sdeps '{:deps {cider/cider-nrepl {:mvn/version "0.49.0"} }}' -M -m nrepl.cmdline --middleware "[cider.nrepl/cider-middleware]"</pre>
<pre>clj -Sdeps '{:deps {cider/cider-nrepl {:mvn/version "0.50.0"} }}' -M -m nrepl.cmdline --middleware "[cider.nrepl/cider-middleware]"</pre>
</div>
</div>
<div class="paragraph">
Expand All @@ -325,12 +324,12 @@ <h2 id="via-clj"><a class="anchor" href="#via-clj"></a>Via clj</h2>
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">{...
:aliases
{:cider-clj {:extra-deps {org.clojure/clojure {:mvn/version "1.10.3"}
cider/cider-nrepl {:mvn/version "0.49.0"}}
cider/cider-nrepl {:mvn/version "0.50.0"}}
:main-opts ["-m" "nrepl.cmdline" "--middleware" "[cider.nrepl/cider-middleware]"]}

:cider-cljs {:extra-deps {org.clojure/clojure {:mvn/version "1.10.3"}
org.clojure/clojurescript {:mvn/version "1.10.339"}
cider/cider-nrepl {:mvn/version "0.49.0"}
cider/cider-nrepl {:mvn/version "0.50.0"}
cider/piggieback {:mvn/version "0.5.2"}}
:main-opts ["-m" "nrepl.cmdline" "--middleware"
"[cider.nrepl/cider-middleware,cider.piggieback/wrap-cljs-repl]"]}}}</code></pre>
Expand Down
Loading

0 comments on commit 85106c4

Please sign in to comment.