Skip to content

Commit

Permalink
Merge pull request #1777 from xerial/patch-1
Browse files Browse the repository at this point in the history
Fix a broken link
  • Loading branch information
lwronski committed Jan 16, 2023
2 parents 66ea06b + 6b7e152 commit e4cfd02
Show file tree
Hide file tree
Showing 13 changed files with 32 additions and 32 deletions.
12 changes: 6 additions & 6 deletions website/docs/commands/basics.md
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 3
import {ChainedSnippets} from "../../src/components/MarkdownComponents.js";

Scala CLI is a command line tool that executes a given sub-command on the inputs it’s provided with, using a
given [configuration](../guides/configuration.md) to produce a result.
given [configuration](/docs/guides/configuration.md) to produce a result.

The most important sub-commands are:

Expand Down Expand Up @@ -44,11 +44,11 @@ Note that all of these input formats can be used alongside each other.
Scala CLI accepts the following types of source code:

- `.scala` files, containing Scala code
- `.sc` files, containing Scala scripts (see more in the [Scripts guide](../guides/scripts.md))
- `.sc` files, containing Scala scripts (see more in the [Scripts guide](/docs/guides/scripts.md))
- `.java` files, containing Java code
- `.md` files, containing Markdown code (experimental, see more in the [Markdown guide](../guides/markdown.md))
- `.md` files, containing Markdown code (experimental, see more in the [Markdown guide](/docs/guides/markdown.md))
- `.c` and `.h` files, containing C code (only as resources for Scala Native, see more in
the [Scala Native guide](../guides/scala-native.md))
the [Scala Native guide](/docs/guides/scala-native.md))
- `.jar` files, (see more in the [Run docs](run#jar))

The following example shows the simplest input format.
Expand Down Expand Up @@ -203,7 +203,7 @@ Hello

</ChainedSnippets>

More details in the [GitHub gists cookbook](../cookbooks/gists.md).
More details in the [GitHub gists cookbook](/docs/cookbooks/gists.md).

### Zip archive

Expand Down Expand Up @@ -304,7 +304,7 @@ You can also pipe code to `scala-cli` for execution:

</ChainedSnippets>

More details in the [Piping guide](../guides/piping.md).
More details in the [Piping guide](/docs/guides/piping.md).

## Scala CLI version

Expand Down
10 changes: 5 additions & 5 deletions website/docs/commands/compile.md
Expand Up @@ -24,7 +24,7 @@ The `compile` command is useful if you want to check that your code compiles

The most common `compile` options are shown below.
For a full list of options, run `scala-cli compile --help`, or check the options linked in the
[reference documentation](../reference/commands.md#compile).
[reference documentation](/docs/reference/commands.md#compile).

## Test scope

Expand Down Expand Up @@ -67,7 +67,7 @@ Watching sources, press Ctrl+C to exit.
## Scala version

Scala CLI uses the latest stable version of Scala which was tested in `scala-cli` (see our list
of [Supported Scala Versions](../reference/scala-versions)). You can specify the Scala version you'd like to use
of [Supported Scala Versions](/docs/reference/scala-versions)). You can specify the Scala version you'd like to use
with `--scala`:

```bash
Expand Down Expand Up @@ -115,7 +115,7 @@ For compiling with a specific nightly build you have the full version:
scala-cli Hello.scala -S 2.13.9-bin-4505094
```

For setting this inside scala files, use [`using` directives](../guides/using-directives.md):
For setting this inside scala files, use [`using` directives](/docs/guides/using-directives.md):

```scala compile
//> using scala "2.nightly"
Expand All @@ -139,15 +139,15 @@ scala-cli compile Hello.scala \
```

Note that `--dependency` is only meant as a convenience. You should favor
adding dependencies in the source files themselves via [`using` directives](../guides/configuration.md#special-imports).
adding dependencies in the source files themselves via [`using` directives](/docs/guides/configuration.md#special-imports).

You can also add simple JAR files — those that don’t have transitive dependencies — as dependencies, with `--jar`:

```bash
scala-cli compile Hello.scala --jar /path/to/library.jar
```

See the [Dependency management](../guides/dependencies.md) guide for more details.
See the [Dependency management](/docs/guides/dependencies.md) guide for more details.

## Scala compiler options

Expand Down
4 changes: 2 additions & 2 deletions website/docs/commands/publishing/publish-setup.md
Expand Up @@ -29,7 +29,7 @@ In particular, one can configure:
- Sonatype credentials (to upload artifacts to Maven Central)
- a GitHub token (to upload repository secrets to GitHub, and artifacts to Maven repositories of GitHub Packages)

User-wide configuration in Scala CLI is handled by the [`config` command](../misc/config.md), and
User-wide configuration in Scala CLI is handled by the [`config` command](/docs/commands/misc/config.md), and
the sections below show how to use it to configure things for `publish setup`.

### User details
Expand Down Expand Up @@ -75,7 +75,7 @@ SONATYPE_USER=me SONATYPE_PASSWORD=1234 scala-cli config publish.credentials s01
```

Note that both user and password arguments are assumed to be secrets, and
accept the format documented [here](../../reference/password-options.md). Beyond environment
accept the format documented [here](/docs/reference/password-options.md). Beyond environment
variables, commands or paths to files can provide those values. They can also be passed
as is on the command line, although this is not recommended for security reasons.

Expand Down
6 changes: 3 additions & 3 deletions website/docs/commands/run.md
Expand Up @@ -229,7 +229,7 @@ It is also possible to achieve it using `--platform` option:
scala-cli Hello.scala --platform js
```

See our dedicated [Scala.js guide](../guides/scala-js.md) for more information.
See our dedicated [Scala.js guide](/docs/guides/scala-js.md) for more information.

## Scala Native

Expand All @@ -246,7 +246,7 @@ It is also possible to achieve it using `--platform` option:
scala-cli Hello.scala --platform native
```

We have a dedicated [Scala Native guide](../guides/scala-native.md) as well.
We have a dedicated [Scala Native guide](/docs/guides/scala-native.md) as well.

## Platform

Expand Down Expand Up @@ -279,7 +279,7 @@ Hello world from scala script

</ChainedSnippets>

Our [scripts guide](../guides/scripts.md) provides many more details.
Our [scripts guide](/docs/guides/scripts.md) provides many more details.

## Scala CLI from docker

Expand Down
2 changes: 1 addition & 1 deletion website/docs/commands/shebang.md
Expand Up @@ -20,5 +20,5 @@ the input, while everything after the input is considered a program argument.
scala-cli shebang [scala_cli_options]... input [program_arguments]...
```

More details can be found in [Shebang guide](../guides/shebang).
More details can be found in [Shebang guide](/docs/guides/shebang).

2 changes: 1 addition & 1 deletion website/docs/commands/test.md
Expand Up @@ -8,7 +8,7 @@ import {ChainedSnippets} from "../../src/components/MarkdownComponents.js";
The `test` command runs test suites in the test sources.
Test sources are compiled separately (after the 'main' sources), and may use different dependencies, compiler options, and other configurations.

By default, all command line options apply to both the main and test sources, so [using directives](/docs/guides/using-directives.md) (or [special imports](../guides/configuration#special-imports)) can be used to provide test-specific configurations.
By default, all command line options apply to both the main and test sources, so [using directives](/docs/guides/using-directives.md) (or [special imports](/docs/guides/configuration#special-imports)) can be used to provide test-specific configurations.

## Test sources

Expand Down
2 changes: 1 addition & 1 deletion website/docs/cookbooks/gists.md
Expand Up @@ -116,4 +116,4 @@ Hello

</ChainedSnippets>

You can find more information on working with Markdown in the [Markdown guide](../guides/markdown.md).
You can find more information on working with Markdown in the [Markdown guide](/docs/guides/markdown.md).
2 changes: 1 addition & 1 deletion website/docs/cookbooks/intro.md
Expand Up @@ -8,4 +8,4 @@ sidebar_position: 1
This section of the documentation contains a set of recipes that show how to use `scala-cli` in certain situations.
The recipes are intended to provide a solution to the task at hand, but also without going into great detail.

For more in-depth analysis, please check out our [Guides](../guides/intro.md)
For more in-depth analysis, please check out our [Guides](/docs/guides/intro.md)
4 changes: 2 additions & 2 deletions website/docs/cookbooks/scala-versions.md
Expand Up @@ -3,7 +3,7 @@ title: Picking the Scala version with scala-cli
sidebar_position: 2
---

By default, `scala-cli` runs the latest supported scala version by Scala CLI. See our list of [Supported Scala Versions](../reference/scala-versions) in Scala CLI.
By default, `scala-cli` runs the latest supported scala version by Scala CLI. See our list of [Supported Scala Versions](/docs/reference/scala-versions) in Scala CLI.

To demonstrate how this works, here’s a universal piece of code that detects the Scala version at runtime.
The code is a bit complicated, so we suggest that you skip reading the whole file, and just focus on what it prints:
Expand Down Expand Up @@ -121,7 +121,7 @@ Scala: 2\.13\.10
-->

:::note
See our [Using Directives Guide](../guides/using-directives.md) for more details on `using` directives.
See our [Using Directives Guide](/docs/guides/using-directives.md) for more details on `using` directives.
:::


Expand Down
4 changes: 2 additions & 2 deletions website/docs/guides/configuration.md
Expand Up @@ -55,7 +55,7 @@ test

</ChainedSnippets>

The reference documentation lists [all of the available options](../reference/cli-options.md).
The reference documentation lists [all of the available options](/docs/reference/cli-options.md).


## In .scala and .sc files
Expand All @@ -75,7 +75,7 @@ This is achieved by specifying `using` directives inside comments at the top of
// package and import statements follow here ...
```

The reference documentation lists [all available using directives](../reference/directives.md#using-directives).
The reference documentation lists [all available using directives](/docs/reference/directives.md#using-directives).

### Special imports

Expand Down
12 changes: 6 additions & 6 deletions website/docs/guides/ide.md
Expand Up @@ -26,7 +26,7 @@ Since Scala CLI has a command-line-first approach, this is reflected in its IDE
By default, Scala CLI stores options passed to the last `compile`, `run`, or `test` command, and uses those options to
configure the IDE.

For more control we also expose the [`setup-ide` command](../commands/setup-ide.md), which lets you fine-tune the
For more control we also expose the [`setup-ide` command](/docs/commands/setup-ide.md), which lets you fine-tune the
options that are passed to the IDE.

But note that once `setup-ide` is used, Scala CLI does not update the configuration based on latest command.
Expand All @@ -50,15 +50,15 @@ being said, proper IDE integration is our top priority at this moment!)

### VS Code with Metals

Check the cookbook on [how to set up a Scala CLI project in VSCode with Metals](../cookbooks/vscode.md).
Check the cookbook on [how to set up a Scala CLI project in VSCode with Metals](/docs/cookbooks/vscode.md).

### IntelliJ

Cookbooks on how to work with IntelliJ:

- [set up a simple Scala CLI project in IDEA IntelliJ](../cookbooks/intellij.md)
- [set up a Scala CLI project in IntelliJ alongside an existing SBT project](../cookbooks/intellij-sbt-with-bsp.md)
- [set up multiple Scala CLI projects in IDEA IntelliJ as separate modules](../cookbooks/intellij-multi-bsp.md)
- [set up a simple Scala CLI project in IDEA IntelliJ](/docs/cookbooks/intellij.md)
- [set up a Scala CLI project in IntelliJ alongside an existing SBT project](/docs/cookbooks/intellij-sbt-with-bsp.md)
- [set up multiple Scala CLI projects in IDEA IntelliJ as separate modules](/docs/cookbooks/intellij-multi-bsp.md)

## Directories vs single files when working with an IDE

Expand Down Expand Up @@ -111,7 +111,7 @@ without the need to jump into the command line whenever you create a new file.
Do note that IDEs do not yet support working with Scala CLI's remote and virtual inputs. That includes:

- [piped sources](./piping.md),
- URLs and [GitHub gists](../cookbooks/gists.md),
- URLs and [GitHub gists](/docs/cookbooks/gists.md),
- [code snippets](./snippets.md).

Beyond that, IDE support for some non-standard (like `.c` and `.h` resources used
Expand Down
2 changes: 1 addition & 1 deletion website/docs/guides/markdown.md
Expand Up @@ -89,7 +89,7 @@ Hello

</ChainedSnippets>

You can find more information on running GitHub Gists in the [gists cookbook](../cookbooks/gists.md).
You can find more information on running GitHub Gists in the [gists cookbook](/docs/cookbooks/gists.md).

### Piped Markdown code

Expand Down
2 changes: 1 addition & 1 deletion website/docs/guides/proxies.md
Expand Up @@ -25,7 +25,7 @@ scala-cli config httpProxy.password _encoded_password_
```

Replace `_encoded_user_` and `_encoded_password_` by your actual user and password, following
the [password option format](../reference/password-options.md). They should typically look like
the [password option format](/docs/reference/password-options.md). They should typically look like
`env:ENV_VAR_NAME`, `file:/path/to/file`, or `command:command to run`.

## Default repositories
Expand Down

0 comments on commit e4cfd02

Please sign in to comment.