docs: migrating docs from readme

This commit is contained in:
Folke Lemaitre 2024-06-19 07:59:45 +02:00
parent eec66ae9f7
commit 692ac7a301
No known key found for this signature in database
GPG key ID: 41F8B1FBACAE2040
15 changed files with 861 additions and 48 deletions

24
docs/spec/versioning.md Normal file
View file

@ -0,0 +1,24 @@
# Versioning
If you want to install a specific revision of a plugin, you can use `commit`,
`tag`, `branch`, `version`.
The `version` property supports [Semver](https://semver.org/) ranges.
:::tip
You can set `config.defaults.version = "*"` to install the latest stable
version of plugins that support Semver.
:::
## Examples
- `*`: latest stable version (this excludes pre-release versions)
- `1.2.x`: any version that starts with `1.2`, such as `1.2.0`, `1.2.3`, etc.
- `^1.2.3`: any version that is compatible with `1.2.3`, such as `1.3.0`, `1.4.5`, etc., but not `2.0.0`.
- `~1.2.3`: any version that is compatible with `1.2.3`, such as `1.2.4`, `1.2.5`, but not `1.3.0`.
- `>1.2.3`: any version that is greater than `1.2.3`, such as `1.3.0`, `1.4.5`, etc.
- `>=1.2.3`: any version that is greater than or equal to `1.2.3`, such as `1.2.3`, `1.3.0`, `1.4.5`, etc.
- `<1.2.3`: any version that is less than `1.2.3`, such as `1.1.0`, `1.0.5`, etc.
- `<=1.2.3`: any version that is less than or equal to `1.2.3`, such as `1.2.3`, `1.1.0`, `1.0.5`, etc