Skip to content

Commit

Permalink
Add and fix markdown lint violations (#66)
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasNieto authored Aug 26, 2024
1 parent 761cb60 commit c047a85
Show file tree
Hide file tree
Showing 32 changed files with 714 additions and 478 deletions.
5 changes: 5 additions & 0 deletions .markdownlint-cli2.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"ignores": [
"docs/api/*.md"
]
}
59 changes: 59 additions & 0 deletions .markdownlint.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
{
"code-block-style": {
"style": "fenced"
},
"code-fence-style": {
"style": "backtick"
},
"emphasis-style": {
"style": "asterisk"
},
"fenced-code-language": {
"allowed_languages": [
"csharp",
"powershell",
"text",
"yaml"
],
"language_only": true
},
"heading-style": {
"style": "atx"
},
"hr-style": {
"style": "---"
},
"line-length": {
"strict": true,
"code_blocks": false,
"headings": false
},
"link-image-style": {
"collapsed": false,
"url_inline": false
},
"no-duplicate-heading": {
"siblings_only": true
},
"ol-prefix": {
"style": "ordered"
},
"proper-names": {
"code_blocks": false,
"names": [
"PowerShell"
]
},
"reference-links-images": {
"shortcut_syntax": true
},
"strong-style": {
"style": "asterisk"
},
"ul-style": {
"style": "dash"
},
"single-title": {
"front_matter_title": ""
}
}
8 changes: 7 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
"anypackage",
"Authenticode",
"creativecommons",
"Nieto"
"LOCALAPPDATA",
"modulefast",
"Nieto",
"nupkg",
"psresourceget",
"Uninitializing",
"winget"
]
}
24 changes: 13 additions & 11 deletions docs/dsc/Package.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,9 @@ Default value: False
### Provider
Specifies the package provider full name.
The provider full name is in the following format: ModuleName\ProviderName.
For AnyPackage PSResourceGet provider it would be: AnyPackage.PSResourceGet\PSResourceGet.
Specifies the package provider full name. The provider full name is in the
following format: ModuleName\ProviderName. For AnyPackage PSResourceGet provider
it would be: AnyPackage.PSResourceGet\PSResourceGet.
```yaml
Attribute: Key
Expand All @@ -88,8 +88,8 @@ Default value: None
### Reasons
Returns reasons why the resource is not in compliance.
The `Code` property is the unique identifier and `Phrase` property is the human readable reason.
Returns reasons why the resource is not in compliance. The `Code` property is
the unique identifier and `Phrase` property is the human readable reason.

```yaml
Attribute: Read
Expand All @@ -109,12 +109,14 @@ Default value: None

### Version

Specifies the package version.
The format is NuGet version range syntax with minor changes.
To specify any package version use `*`.
In normal NuGet version range value of `1.0` would be minimum version inclusive but this parameter converts that value to be exact version of `[1.0]`.
If you need to have minimum version inclusive then use this format `[1.0,]`.
For more information refer to [NuGet version range syntax](https://learn.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges).
Specifies the package version. The format is NuGet version range syntax with
minor changes. To specify any package version use `*`. In normal NuGet version
range value of `1.0` would be minimum version inclusive but this parameter
converts that value to be exact version of `[1.0]`. If you need to have minimum
version inclusive then use this format `[1.0,]`. For more information refer to
[NuGet version range syntax][nuget].

[nuget]: https://learn.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges

```yaml
Attribute: Key
Expand Down
14 changes: 7 additions & 7 deletions docs/dsc/Source.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@ Default value: None
### Provider
Specifies the package provider full name.
The provider full name is in the following format: ModuleName\ProviderName.
For AnyPackage PSResourceGet provider it would be: AnyPackage.PSResourceGet\PSResourceGet.
Specifies the package provider full name. The provider full name is in the
following format: ModuleName\ProviderName. For AnyPackage PSResourceGet provider
it would be: AnyPackage.PSResourceGet\PSResourceGet.
```yaml
Attribute: Key
Expand All @@ -76,8 +76,8 @@ Default value: None
### Reasons
Returns reasons why the resource is not in compliance.
The `Code` property is the unique identifier and `Phrase` property is the human readable reason.
Returns reasons why the resource is not in compliance. The `Code` property is
the unique identifier and `Phrase` property is the human readable reason.

```yaml
Attribute: Read
Expand All @@ -87,8 +87,8 @@ Default value: N/A

### Trusted

Specifies if the package source is trusted.
If set to `true` it prevents interactive untrusted source prompts.
Specifies if the package source is trusted. If set to `true` it prevents
interactive untrusted source prompts.

```yaml
Attribute: Write
Expand Down
33 changes: 17 additions & 16 deletions docs/provider-catalog/chocolatey/about_Chocolatey_Provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,49 +13,50 @@ Provides access to Chocolatey.

## Long Description

The Chocolatey package provider for `AnyPackage` module lets you use Chocolatey using standardized commands.
The Chocolatey package provider for `AnyPackage` module lets you use Chocolatey
using standardized commands.

The Chocolatey package provider supports the following cmdlets.

* Find-Package
* Get-Package
* Get-PackageSource
* Install-Package
* Register-PackageSource
* Set-PackageSource
* Uninstall-Package
* Unregister-PackageSource
- Find-Package
- Get-Package
- Get-PackageSource
- Install-Package
- Register-PackageSource
- Set-PackageSource
- Uninstall-Package
- Unregister-PackageSource

## Dynamic Parameters

Dynamic parameters are cmdlet parameters that are added by a package
provider and are available only when `-Provider Chocolatey` parameter is used.
Dynamic parameters are cmdlet parameters that are added by a package provider
and are available only when `-Provider Chocolatey` parameter is used.

### Params <System.String>

Parameters to pass to the package being installed.

#### Cmdlets Supported

* Install-Package
- Install-Package

### ParamsGlobal <System.Management.Automation.SwitchParameter>

Apply package parameters to dependencies of package being installed.

#### Cmdlets Supported

* Install-Package
- Install-Package

### RemoveDependencies <System.Management.Automation.SwitchParameter>

Uninstall dependencies of package being uninstalled.

#### Cmdlets Supported

* Uninstall-Package
- Uninstall-Package

## See Also

* [about_Package_Providers](../../reference/about_Package_Providers.md)
* [about_AnyPackage](../../reference/about_AnyPackage.md)
- [about_Package_Providers](../../reference/about_Package_Providers.md)
- [about_AnyPackage](../../reference/about_AnyPackage.md)
21 changes: 11 additions & 10 deletions docs/provider-catalog/dotnet-tool/about_DotNet-Tool_Provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,25 @@ Provides access to .NET Tool package manager.

## Long Description

The Windows .NET Tool package provider for `AnyPackage` module lets you get .NET Tools from nuget.org
The Windows .NET Tool package provider for `AnyPackage` module lets you get .NET
Tools from nuget.org

The .NET Tool package provider supports the following cmdlets.

* Find-Package
* Get-Package
* Install-Package
* Update-Package
* Uninstall-Package
- Find-Package
- Get-Package
- Install-Package
- Update-Package
- Uninstall-Package

## Dynamic Parameters

Dynamic parameters are cmdlet parameters that are added by a package
provider and are available only when `-Provider '.NET Tool'` parameter is used.
Dynamic parameters are cmdlet parameters that are added by a package provider
and are available only when `-Provider '.NET Tool'` parameter is used.

The .NET Tool provider currently has no dynamic parameters.

## See Also

* [about_Package_Providers](../../reference/about_Package_Providers.md)
* [about_AnyPackage](../../reference/about_AnyPackage.md)
- [about_Package_Providers](../../reference/about_Package_Providers.md)
- [about_AnyPackage](../../reference/about_AnyPackage.md)
27 changes: 14 additions & 13 deletions docs/provider-catalog/homebrew/about_Homebrew_Provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,27 +13,28 @@ Provides access to Homebrew.

## Long Description

The Homebrew package provider for `AnyPackage` module lets you use Homebrew using standardized commands.
The Homebrew package provider for `AnyPackage` module lets you use Homebrew
using standardized commands.

The Homebrew package provider supports the following cmdlets.

* Find-Package
* Get-Package
* Get-PackageSource
* Install-Package
* Register-PackageSource
* Set-PackageSource
* Uninstall-Package
* Unregister-PackageSource
- Find-Package
- Get-Package
- Get-PackageSource
- Install-Package
- Register-PackageSource
- Set-PackageSource
- Uninstall-Package
- Unregister-PackageSource

## Dynamic Parameters

Dynamic parameters are cmdlet parameters that are added by a package
provider and are available only when `-Provider Homebrew` parameter is used.
Dynamic parameters are cmdlet parameters that are added by a package provider
and are available only when `-Provider Homebrew` parameter is used.

The Homebrew provider currently has no dynamic parameters.

## See Also

* [about_Package_Providers](../../reference/about_Package_Providers.md)
* [about_AnyPackage](../../reference/about_AnyPackage.md)
- [about_Package_Providers](../../reference/about_Package_Providers.md)
- [about_AnyPackage](../../reference/about_AnyPackage.md)
Loading

0 comments on commit c047a85

Please sign in to comment.