Skip to content
This repository has been archived by the owner on Aug 19, 2024. It is now read-only.

Commit

Permalink
add:scroll offset for usage & vendors pages
Browse files Browse the repository at this point in the history
  • Loading branch information
@SvMak @marc0der
SvMak authored and marc0der committed Apr 25, 2024
1 parent 0c49585 commit ad27ec7
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 24 deletions.
38 changes: 19 additions & 19 deletions app/views/usage.scala.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ <h1 id="usage">Usage</h1>
@includes.advertisement()

<article>
<h2 id="installdefault">Installing an SDK</h2>
<h2 id="installdefault" class="scroll-offset">Installing an SDK</h2>
<br>

<h4>Latest Stable</h4>
Expand Down Expand Up @@ -68,7 +68,7 @@ <h4>Latest Stable</h4>
<pre><code>Setting java @javaVersion as default.</code></pre>
<br>

<h4 id="installspecific">Specific Version</h4>
<h4 id="installspecific" class="scroll-offset">Specific Version</h4>
<p>
Need a <strong>specific</strong> version of an SDK? Simply qualify the
version you require:
Expand All @@ -77,7 +77,7 @@ <h4 id="installspecific">Specific Version</h4>
<p>All subsequent steps same as above.</p>
<br>

<h4 id="localversion">Install Local Version(s)</h4>
<h4 id="localversion" class="scroll-offset">Install Local Version(s)</h4>
<p>
Using a snapshot version? Already have a local installation? Setup a local version by specifying
the path to the local installation:
Expand All @@ -93,15 +93,15 @@ <h4 id="localversion">Install Local Version(s)</h4>
<br>

<article>
<h2 id="remove">Remove Version</h2>
<h2 id="remove" class="scroll-offset">Remove Version</h2>
<p>Remove an installed version.</p>
<pre><code>$ sdk uninstall scala @scalaVersion</code></pre>
<p>Note that removing a local version will not remove the local installation.</p>
</article>
<br>

<article>
<h2 id="listcandidates">List Candidates</h2>
<h2 id="listcandidates" class="scroll-offset">List Candidates</h2>
<p>To get a listing of available Candidates:</p>
<pre><code>$ sdk list</code></pre>
<p>
Expand Down Expand Up @@ -136,7 +136,7 @@ <h2 id="listcandidates">List Candidates</h2>
<br>

<article>
<h2 id="listversions">List Versions</h2>
<h2 id="listversions" class="scroll-offset">List Versions</h2>
<p>To get a listing of Candidate Versions:</p>
<pre><code>$ sdk list groovy</code></pre>
<p>
Expand Down Expand Up @@ -172,7 +172,7 @@ <h2 id="listversions">List Versions</h2>
<br>

<article>
<h2 id="use">Use Version</h2>
<h2 id="use" class="scroll-offset">Use Version</h2>
<p>Choose to use a given version in the current terminal:</p>
<pre><code>$ sdk use scala @scalaVersion</code></pre>
<p>
Expand All @@ -183,15 +183,15 @@ <h2 id="use">Use Version</h2>
<br>

<article>
<h2 id="default">Default Version</h2>
<h2 id="default" class="scroll-offset">Default Version</h2>
<p>Chose to make a given version the default:</p>
<pre><code>$ sdk default scala @scalaVersion</code></pre>
<p>This will ensure that all subsequent shells will start with version @scalaVersion in use.</p>
</article>
<br>

<article>
<h2 id="current">Current Version(s)</h2>
<h2 id="current" class="scroll-offset">Current Version(s)</h2>
<p>To see what is currently in use for a Candidate:</p>
<pre><code>$ sdk current java
Using java version @javaVersion
Expand All @@ -207,7 +207,7 @@ <h2 id="current">Current Version(s)</h2>
<br>

<article>
<h2 id="env">Env Command</h2>
<h2 id="env" class="scroll-offset">Env Command</h2>
<p>
Want to switch to a specific JDK or SDK every time you visit a project?
This can be achieved through an <code>.sdkmanrc</code> file in the base
Expand Down Expand Up @@ -267,7 +267,7 @@ <h2 id="env">Env Command</h2>
<br>

<article>
<h2 id="upgrade">Upgrade Version(s)</h2>
<h2 id="upgrade" class="scroll-offset">Upgrade Version(s)</h2>
<p>To see what is currently out of date for a Candidate on your system:</p>
<pre><code>$ sdk upgrade springboot
Upgrade:
Expand All @@ -284,7 +284,7 @@ <h2 id="upgrade">Upgrade Version(s)</h2>
<br>

<article>
<h2 id="version">SDKMAN! Version</h2>
<h2 id="version" class="scroll-offset">SDKMAN! Version</h2>
<p>Display the current script and native versions of SDKMAN!:</p>
<pre><code>$ sdk version

Expand All @@ -296,7 +296,7 @@ <h2 id="version">SDKMAN! Version</h2>
<br>

<article>
<h2 id="offline">Offline Mode</h2>
<h2 id="offline" class="scroll-offset">Offline Mode</h2>
<p>
Initially called <em>Aeroplane Mode</em>, this allows SDKMAN! to function
when working offline. It has a parameter that can be passed
Expand Down Expand Up @@ -331,7 +331,7 @@ <h2 id="offline">Offline Mode</h2>
<br>

<article>
<h2 id="selfupdate">Self-Update</h2>
<h2 id="selfupdate" class="scroll-offset">Self-Update</h2>
<p>Installs a new version of SDKMAN! if available.</p>
<pre><code>$ sdk selfupdate</code></pre>
<p>
Expand All @@ -347,7 +347,7 @@ <h2 id="selfupdate">Self-Update</h2>
<br>

<article>
<h2 id="update">Update</h2>
<h2 id="update" class="scroll-offset">Update</h2>
<p>
Periodically SDKMAN! requires a refresh to become aware of new (or removed)
candidates.
Expand All @@ -366,7 +366,7 @@ <h2 id="update">Update</h2>
<br>

<article>
<h2 id="flush">Flush</h2>
<h2 id="flush" class="scroll-offset">Flush</h2>
<p>
It should rarely be necessary to flush SDKMAN!&apos;s local state.
The flush command helps with this, so you don't need to delete any directories.
Expand All @@ -381,7 +381,7 @@ <h2 id="flush">Flush</h2>
<br>

<article>
<h2 id="home">Home</h2>
<h2 id="home" class="scroll-offset">Home</h2>
<p>
When using SDKMAN in scripts, it is often useful to get the absolute
path of where an SDK resides (similar to how the <code>java_home</code>
Expand All @@ -394,7 +394,7 @@ <h2 id="home">Home</h2>
<br>

<article>
<h2 id="help">Help</h2>
<h2 id="help" class="scroll-offset">Help</h2>
<p>You can get basic help by running the following command:</p>
<pre><code>$ sdk help</code></pre>
<p>
Expand All @@ -407,7 +407,7 @@ <h2 id="help">Help</h2>
<br>

<article>
<h2 id="config">Configuration</h2>
<h2 id="config" class="scroll-offset">Configuration</h2>
<p>
Configuration can be found in the <code>~/.sdkman/etc/config</code> file. To edit the
configuration, the <code>sdk config</code> command may be issued to edit this file
Expand Down
10 changes: 5 additions & 5 deletions app/views/vendors.scala.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ <h1 id="vendors">Vendors</h1>
<br>

<article>
<h3 id="operations">Operations</h3>
<h3 id="operations" class="scroll-offset">Operations</h3>
The API is a simple JSON REST API that allows three basic operations:
<ul>
<li>Release a new candidate version</li>
Expand All @@ -40,7 +40,7 @@ <h3 id="operations">Operations</h3>
<br>

<article>
<h3 id="access">Access</h3>
<h3 id="access" class="scroll-offset">Access</h3>
<p>This is a secured API, and requires appropriate credentials to perform the
above operations. Access will be granted on a
case-by-case basis to Vendors who are interested in making their SDK
Expand All @@ -51,7 +51,7 @@ <h3 id="access">Access</h3>
<br>

<article>
<h3 id="endpoints">Endpoints</h3>
<h3 id="endpoints" class="scroll-offset">Endpoints</h3>
The simplest way to call the API is by using <a href='https://curl.se/'>curl</a>. Of course,
any other client can be used to perform the API operations.

Expand Down Expand Up @@ -158,7 +158,7 @@ <h5>Sample payload</h5>
<br>

<article>
<h3 id="gradleplugin">Gradle SDK Vendor Plugin</h3>
<h3 id="gradleplugin" class="scroll-offset">Gradle SDK Vendor Plugin</h3>
<p>If fiddling with cURL (or HttpClient) isn’t your thing, you could consider
using our Gradle plugin. The plugin allows the release to be done as a side
effect of your CI build! It exposes several useful tasks like:
Expand All @@ -183,7 +183,7 @@ <h3 id="gradleplugin">Gradle SDK Vendor Plugin</h3>
<br>

<article>
<h3 id="mavenplugin">Maven SDK Vendor Plugin</h3>
<h3 id="mavenplugin" class="scroll-offset">Maven SDK Vendor Plugin</h3>
<p>If fiddling with cURL (or HttpClient) or Gradle isn’t your thing, you could consider
using our Maven plugin. The plugin allows the release to be done as a side
effect of your CI build! It exposes several useful goals like:
Expand Down

0 comments on commit ad27ec7

Please sign in to comment.