Skip to content

Commit

Permalink
[skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Jun 20, 2024
1 parent 7c4bda4 commit a705437
Show file tree
Hide file tree
Showing 9 changed files with 81 additions and 80 deletions.
2 changes: 1 addition & 1 deletion eval-tips/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2242,7 +2242,7 @@


<h1 id="code-evaluation">Code Evaluation<a class="headerlink" href="#code-evaluation" title="Permanent link">#</a></h1>
<p>Calva tries to make it easy to evaluate code, supporting interactive development. The fastest path to learning about it is to use the <strong>Fire up the Getting Started REPL</strong> command, which you can learn more about in the <a href="../getting-started/">Getting Started</a> section.</p>
<p>Calva tries to make it easy to evaluate code, supporting interactive development. The fastest path to learning about it is to use the <strong>Create a Getting Started REPL project</strong> command, which you can learn more about in the <a href="../getting-started/">Getting Started</a> section.</p>
<p>NB: <em>The below assumes you have read about <a href="../finding-commands/">Finding Calva Commands and Shortcuts</a>.</em></p>
<h2 id="interruptingstopping-running-evaluations">Interrupting/stopping running evaluations<a class="headerlink" href="#interruptingstopping-running-evaluations" title="Permanent link">#</a></h2>
<p>Sometimes you evaluate things that take a very long time to complete, or might not even ever complete (infinite loops, lazy sequences, things like that). Calva has a command for interrupting running evaluations. You find it in the VS Code command palette, as well as in the REPL status bar item menu, when the REPL is connected.</p>
Expand Down
2 changes: 1 addition & 1 deletion evaluation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2242,7 +2242,7 @@


<h1 id="code-evaluation">Code Evaluation<a class="headerlink" href="#code-evaluation" title="Permanent link">#</a></h1>
<p>Calva tries to make it easy to evaluate code, supporting interactive development. The fastest path to learning about it is to use the <strong>Fire up the Getting Started REPL</strong> command, which you can learn more about in the <a href="../getting-started/">Getting Started</a> section.</p>
<p>Calva tries to make it easy to evaluate code, supporting interactive development. The fastest path to learning about it is to use the <strong>Create a Getting Started REPL project</strong> command, which you can learn more about in the <a href="../getting-started/">Getting Started</a> section.</p>
<p>NB: <em>The below assumes you have read about <a href="../finding-commands/">Finding Calva Commands and Shortcuts</a>.</em></p>
<h2 id="interruptingstopping-running-evaluations">Interrupting/stopping running evaluations<a class="headerlink" href="#interruptingstopping-running-evaluations" title="Permanent link">#</a></h2>
<p>Sometimes you evaluate things that take a very long time to complete, or might not even ever complete (infinite loops, lazy sequences, things like that). Calva has a command for interrupting running evaluations. You find it in the VS Code command palette, as well as in the REPL status bar item menu, when the REPL is connected.</p>
Expand Down
4 changes: 2 additions & 2 deletions get-started-with-clojure/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2275,8 +2275,8 @@ <h2 id="start-the-guide">Start the Guide<a class="headerlink" href="#start-the-g
<li>Open a few Clojure files, introducing you to some basics of how to use Calva and then to learning Clojure.</li>
</ol>
<p>The instructions will be in the form of Clojure comments, and you will be running the Clojure code snippets in the files, as well as be encouraged to edit and add code.</p>
<p>The command to run is: <strong>Calva: Fire up the Getting Started REPL</strong>.</p>
<p><img alt="VS Code Command Palette, Calva Getting Started" src="/images/getting-started-with-clojure/vscode-command-palette-calva-getting-started.png.jpg" /></p>
<p>The command to run is: <strong>Calva: Create a Getting Started REPL project</strong>.</p>
<p><img alt="VS Code Command Palette, Calva Getting Started" src="/images/getting-started-with-clojure/vscode-command-palette-calva-getting-started.png" /></p>
<p>That's it. Do it now. This page has some more information to make the start of your Clojure adventure fun and smooth. It ain't going anywhere, though. 😀 Come back to it.</p>
<details class="note" open="open">
<summary>Stuck? Something not working? Or just unclear?</summary>
Expand Down
25 changes: 13 additions & 12 deletions getting-started/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -428,9 +428,9 @@
</li>

<li class="md-nav__item">
<a href="#there-is-also-standalone-repl" class="md-nav__link">
<a href="#create-a-minimal-clojure-project" class="md-nav__link">
<span class="md-ellipsis">
There is also Standalone REPL
Create a minimal Clojure project
</span>
</a>

Expand Down Expand Up @@ -2125,9 +2125,9 @@
</li>

<li class="md-nav__item">
<a href="#there-is-also-standalone-repl" class="md-nav__link">
<a href="#create-a-minimal-clojure-project" class="md-nav__link">
<span class="md-ellipsis">
There is also Standalone REPL
Create a minimal Clojure project
</span>
</a>

Expand Down Expand Up @@ -2195,28 +2195,29 @@ <h2 id="say-hello-to-calva">Say hello to Calva<a class="headerlink" href="#say-h
<p>See <a href="../get-started-with-clojure/">Get Started with Clojure</a>.</p>
</details>
<h3 id="theres-a-getting-started-repl">There's a ”Getting Started” REPL<a class="headerlink" href="#theres-a-getting-started-repl" title="Permanent link">#</a></h3>
<p>If you are new to Calva, a good place to start is using the command <strong>Fire up the ”Getting Started” REPL</strong>. (You can open the command palette using the VS Code top menu by going to <code>View -&gt; Command Palette...</code> or by running the associated keyboard shortcut for your OS.) Demo:</p>
<p><img alt="Command Palette Start Standalone REPL" src="../images/howto/start-hello-repl.png" title="Fire up the ”Getting Started” REPL" /></p>
<p>It will open up a three files in a temporary directory, and start and connect a REPL. The files are:</p>
<p>If you are new to Calva, a good place to start is using the command <strong>Calva: Create a ”Getting Started” REPL</strong>. (You can open the command palette using the VS Code top menu by going to <code>View -&gt; Command Palette...</code> or by running the associated keyboard shortcut for your OS.) Demo:</p>
<p><img alt="Command Palette Getting Started REPL" src="/images/getting-started-with-clojure/vscode-command-palette-calva-getting-started.png" title="Create a ”Getting Started” REPL" /></p>
<p>It will create a new project, open up a three files, and start and connect a REPL. The files are:</p>
<ul>
<li><code>hello_repl.clj</code> – The basics of how to evaluate code in Calva</li>
<li><code>hello_paredit.clj</code> - A super brief intro to Calva structural editing</li>
<li><code>welcome_to_clojure.clj</code> - The very basics of the Clojure language</li>
</ul>
<p><img alt="Hello REPL" src="../images/howto/hello-repl.png" title="hello-repl.clj" /></p>
<p>The only prerequisite here is that you have Java installed. <em>No pre-installed clojure tools required.</em> (You will want to install these tools later, of course.)</p>
<p>The only prerequisite here is that you have Java installed.</p>
<p>See the <a href="../get-started-with-clojure/">Getting Started with Clojure</a> guide for a bit more about this feature.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>On Windows the Oracle Java installer sets Java up in some funny way so that the Getting Started REPL fails to start. We are figuring about workarounds for this, but for now, if you are on Windows, you will need to make VS Code have some other Java in the <code>PATH</code> of its environment for this feature to work. See <a href="https://github.com/BetterThanTomorrow/calva/issues/1162">this issue on the Calva repo</a> for more on this, including any progress.</p>
</div>
<h3 id="there-are-standalone-clojurescript-quick-start-repls">There are standalone ”ClojureScript Quick Start” REPLs<a class="headerlink" href="#there-are-standalone-clojurescript-quick-start-repls" title="Permanent link">#</a></h3>
<p>Without creating a project structure or installing anything but Calva, you can start standalone ClojureScript REPLs both in a browser and for node:</p>
<ul>
<li>Fire up the ClojureScript Quick Start <strong>Browser</strong> REPL<ul>
<li>Create a ClojureScript Quick Start <strong>Browser</strong> project<ul>
<li>Opens the files <code>core.cljs</code> and <code>index.html</code> and starts the ClojureScript app, opening it in the browser.</li>
</ul>
</li>
<li>Fire up the ClojureScript Quick Start <strong>Node</strong> REPL<ul>
<li>Create a ClojureScript Quick Start <strong>Node</strong> project<ul>
<li>Opens a file, <code>core.cljs</code>, and starts a nodejs REPL where it loads the file.</li>
</ul>
</li>
Expand All @@ -2232,8 +2233,8 @@ <h2 id="clojure-resources">Clojure Resources<a class="headerlink" href="#clojure
<li><a href="https://clojurescript.org/guides/quick-start">ClojureScript Quick Start</a></li>
</ul>
<p>There are also many great books on Clojure. <a href="https://www.braveclojure.com/clojure-for-the-brave-and-true/">Clojure for the Brave and True</a> can be read for free online. It is a great resource for beginners.</p>
<h2 id="there-is-also-standalone-repl">There is also Standalone REPL<a class="headerlink" href="#there-is-also-standalone-repl" title="Permanent link">#</a></h2>
<p>When you are more familiar with Calva, and want a standalone REPL, there is a separate command: <strong>Start a standalone REPL (not in project)</strong>. It will open up a <code>user.clj</code> in a temporary directory, containing only an <code>(ns user)</code> form, and start and connect the REPL.</p>
<h2 id="create-a-minimal-clojure-project">Create a minimal Clojure project<a class="headerlink" href="#create-a-minimal-clojure-project" title="Permanent link">#</a></h2>
<p>When you are more familiar with Calva, and want a standalone REPL, there is a separate command: <strong>Calva: Create a minimal Clojure project</strong>. It will ask for folder to create the project in, and open this project for you, connecting the REPL. The project is <em>really</em> minimal.</p>
<h2 id="dram-where-the-guides-live">Dram - Where the Guides Live<a class="headerlink" href="#dram-where-the-guides-live" title="Permanent link">#</a></h2>
<p>The command for starting the Getting Started REPL will download the files from <a href="https://github.com/BetterThanTomorrow/dram">this repository</a>. It is very much work in progress, and there is not even a finished Clojure Beginner's Guide there yet. When you run the command again, and from then on, you will get the option to download new files or keep using your existing. Downloading new ones will not overwrite your existing ones, because they will be downloaded to a new temp directory. You can find the directory easily using VS Codes context menu command for revealing a file in the Explorer/Finder.</p>
<h2 id="one-last-thing">One Last Thing<a class="headerlink" href="#one-last-thing" title="Permanent link">#</a></h2>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Loading

0 comments on commit a705437

Please sign in to comment.