Skip to content

Commit

Permalink
📝 update doc to latest instead of main
Browse files Browse the repository at this point in the history
  • Loading branch information
jcaillon committed Jul 8, 2024
1 parent 9c6cd65 commit 3a10d53
Show file tree
Hide file tree
Showing 14 changed files with 774 additions and 612 deletions.
10 changes: 8 additions & 2 deletions docs/content/docs/002.installation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,19 @@ url: /docs/installation
Run the following command to install Valet:

```bash
bash -c "$(curl -fsSL https://raw.githubusercontent.com/jcaillon/valet/main/valet.d/commands.d/self-install.sh)"
bash -c "$(curl -fsSL https://raw.githubusercontent.com/jcaillon/valet/latest/valet.d/commands.d/self-install.sh)"
```

{{< callout type="info" emoji="💡" >}}
Please review the [installation script](https://github.com/jcaillon/valet/blob/main/valet.d/commands.d/self-install.sh) to learn about the different installer options.
Please review the [installation script](https://github.com/jcaillon/valet/blob/latest/valet.d/commands.d/self-install.sh) or the [self install command usage](https://github.com/jcaillon/valet/blob/latest/tests.d/1106-self-update/results.approved.md) to learn about the different installer options.
{{< /callout >}}

Here is an example command to install Valet with the option `--unattended`:

```bash
bash -c "$(curl -fsSL https://raw.githubusercontent.com/jcaillon/valet/latest/valet.d/commands.d/self-install.sh)" -s --unattended
```

## 🪛 Manual installation

1. Download the package from the [latest release from GitHub][latest-release].
Expand Down
4 changes: 2 additions & 2 deletions docs/content/docs/020.new-commands/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -282,9 +282,9 @@ You can activate the debug log level with Valet `-v` option, e.g. `valet -v my c
[performance-tips]: performance-tips
[configuration]: ../configuration
[shebang]: https://en.wikipedia.org/wiki/Shebang_(Unix)
[showcase-commands]: https://github.com/jcaillon/valet/tree/main/examples.d/showcase
[showcase-commands]: https://github.com/jcaillon/valet/tree/latest/examples.d/showcase
[command-properties]: ../command-properties
[core-library]: ../core-library
[bash-manual-set]: https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html#index-set
[profiler-output-example]: https://github.com/jcaillon/valet/blob/main/tests.d/1301-profiler/results.approved.md
[profiler-output-example]: https://github.com/jcaillon/valet/blob/latest/tests.d/1301-profiler/results.approved.md
[libraries]: ../libraries
8 changes: 4 additions & 4 deletions docs/content/docs/030.test-commands/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,8 @@ In addition to the test scripts, you can create other specific scripts which wil
{{< card icon="arrow-circle-right" link="../libraries" title="Libraries" >}}
{{< /cards >}}

[valet-test-suites]: https://github.com/jcaillon/valet/tree/main/tests.d
[valet-string-tests-report]: https://github.com/jcaillon/valet/blob/main/tests.d/1003-lib-string/results.approved.md
[valet-string-lib-tests]: https://github.com/jcaillon/valet/blob/main/tests.d/1003-lib-string/00.tests.sh
[showcase-tests]: https://github.com/jcaillon/valet/blob/main/examples.d/showcase/tests.d/001-showcase-test-suite/00.tests.sh
[valet-test-suites]: https://github.com/jcaillon/valet/tree/latest/tests.d
[valet-string-tests-report]: https://github.com/jcaillon/valet/blob/latest/tests.d/1003-lib-string/results.approved.md
[valet-string-lib-tests]: https://github.com/jcaillon/valet/blob/latest/tests.d/1003-lib-string/00.tests.sh
[showcase-tests]: https://github.com/jcaillon/valet/blob/latest/examples.d/showcase/tests.d/001-showcase-test-suite/00.tests.sh
[libraries-tests]: ../libraries/test
4 changes: 2 additions & 2 deletions docs/content/docs/500.working-on-bash/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@ Here is a list of recommended extensions to work on bash scripts:
- [Snippets for bash scripts](https://marketplace.visualstudio.com/items?itemName=Remisa.shellman)
- [Snippets for shebang](https://marketplace.visualstudio.com/items?itemName=rpinski.shebang-snippets)

GitHub Copilot is of great help if you can have it. You can also find the list of [extensions here](https://github.com/jcaillon/valet/blob/main/.vscode/extensions.json).
GitHub Copilot is of great help if you can have it. You can also find the list of [extensions here](https://github.com/jcaillon/valet/blob/latest/.vscode/extensions.json).

## VS code settings

You can open your `~/.valet.d` directory as a workspace on vscode.

I recommend to copy (or link) the [extras/all-valet-functions.sh](https://github.com/jcaillon/valet/blob/main/extras/all-valet-functions.sh) file present in the Valet installation to `~/.valet.d/.vscode/all-valet-functions.sh` in your workspace folder and add the following settings in your `~/.valet.d/.vscode/settings.json`:
I recommend to copy (or link) the [extras/all-valet-functions.sh](https://github.com/jcaillon/valet/blob/latest/extras/all-valet-functions.sh) file present in the Valet installation to `~/.valet.d/.vscode/all-valet-functions.sh` in your workspace folder and add the following settings in your `~/.valet.d/.vscode/settings.json`:

```json
{
Expand Down
Loading

0 comments on commit 3a10d53

Please sign in to comment.