Skip to content

Commit

Permalink
(chocolateyGH-159) (doc) Fixes Markdown syntax when code is a link
Browse files Browse the repository at this point in the history
When code is used in a link, the Markdown syntax with the pipe
command no longer works. This commit fixes the Markdown files in
which this occurs.
  • Loading branch information
trncb committed Oct 25, 2019
1 parent 82d304a commit 4184f8e
Show file tree
Hide file tree
Showing 13 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion CommandsInstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Installs a package or a list of packages (sometimes specified as a
packages.config). Some may prefer to use `cinst` as a shortcut for
[[`choco install`|Commandsinstall]].
[`choco install`](CommandsInstall).

**NOTE:** 100% compatible with older chocolatey client (0.9.8.32 and below)
with options and switches. Add `-y` for previous behavior with no
Expand Down
2 changes: 1 addition & 1 deletion CommandsList.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# List/Search Command (choco list)

Chocolatey will perform a search for a package local or remote. Some
may prefer to use [[`clist`|Commandslist]] as a shortcut for [[`choco list`|Commandslist]].
may prefer to use [`clist`](CommandsList) as a shortcut for [`choco list`](CommandsList).

**NOTE:** 100% compatible with older Chocolatey client (0.9.8.x and below)
with options and switches. In most cases you can still pass options
Expand Down
2 changes: 1 addition & 1 deletion CommandsPin.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Pin a package to suppress upgrades.

This is especially helpful when running [[`choco upgrade`|Commandsupgrade]] for all
This is especially helpful when running [`choco upgrade`](CommandsUpgrade) for all
packages, as it will automatically skip those packages. Another
alternative is `choco upgrade --except="pkg1,pk2"`.

Expand Down
2 changes: 1 addition & 1 deletion CommandsPush.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ A feed can be a local folder, a file share, the [community feed](https://chocola

To use this command, you must have your API key saved for the community
feed (chocolatey.org) or the source you want to push to. Or you can
explicitly pass the apikey to the command. See [[`apikey`|Commandsapikey]] command help
explicitly pass the apikey to the command. See [`apikey`](CommandsApiKey]] command help
for instructions on saving your key:

choco apikey -?
Expand Down
10 changes: 5 additions & 5 deletions CommandsReference.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This is a listing of all of the different things you can pass to choco.
* [[setapikey|CommandsSetapikey]] - retrieves or saves an apikey for a particular source (alias for apikey)
* [[apikey|CommandsApikey]] - retrieves or saves an apikey for a particular source
* [[unpackself|CommandsUnpackself]] - have chocolatey set itself up
* [[version|CommandsVersion]] - [DEPRECATED] will be removed in v1 - use [[`choco outdated`|Commandsoutdated]] or `cup <pkg|all> -whatif` instead
* [[version|CommandsVersion]] - [DEPRECATED] will be removed in v1 - use [`choco outdated`](CommandsOutdated) or `cup <pkg|all> -whatif` instead
* [[update|CommandsUpdate]] - [DEPRECATED] RESERVED for future use (you are looking for upgrade, these are not the droids you are looking for)
* [[support|CommandsSupport]] - provides support information
* [[download|CommandsDownload]] - downloads packages - optionally internalizing all remote resources
Expand Down Expand Up @@ -100,9 +100,9 @@ based on choco not receiving things you think you are passing to it.
* For consistency, always use `choco`, not `choco.exe`. Never use
shortcut commands like `cinst` or `cup`.
* Always have the command as the first argument to `choco. e.g.
[[`choco install`|Commandsinstall]], where [[`install`|Commandsinstall]] is the command.
[`choco install`](CommandsInstall), where [`install`](CommandsInstall) is the command.
* If there is a subcommand, ensure that is the second argument. e.g.
`choco source list`, where `source` is the command and [[`list`|Commandslist]] is the
`choco source list`, where `source` is the command and [`list`](CommandsList) is the
subcommand.
* Typically the subject comes next. If installing packages, the
subject would be the package names, e.g. `choco install pkg1 pkg2`.
Expand Down Expand Up @@ -137,8 +137,8 @@ based on choco not receiving things you think you are passing to it.
* If you are building PowerShell scripts, you can most likely just
simply use apostrophes surrounding option values, e.g.
`--source='internal_server'`.
* Prefer upgrade to install in scripts. You can't [[`install`|Commandsinstall]] to a newer
version of something, but you can [[`choco upgrade`|Commandsupgrade]] which will do both
* Prefer upgrade to install in scripts. You can't [`install`](CommandsInstall) to a newer
version of something, but you can [`choco upgrade`](CommandsUpgrade) which will do both
upgrade or install (unless switched off explicitly).
* If you are sharing the script with others, pass `--source` to be
explicit about where the package is coming from. Use full link and
Expand Down
2 changes: 1 addition & 1 deletion CommandsSearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# List/Search Command (choco search)

Chocolatey will perform a search for a package local or remote. Some
may prefer to use [[`clist`|Commandslist]] as a shortcut for [[`choco list`|Commandslist]].
may prefer to use [`clist`](CommandsList) as a shortcut for [`choco list`](CommandsList).

**NOTE:** 100% compatible with older Chocolatey client (0.9.8.x and below)
with options and switches. In most cases you can still pass options
Expand Down
2 changes: 1 addition & 1 deletion CommandsUninstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Uninstall Command (choco uninstall)

Uninstalls a package or a list of packages. Some may prefer to use
`cuninst` as a shortcut for [[`choco uninstall`|Commandsuninstall]].
`cuninst` as a shortcut for [`choco uninstall`](CommandsUninstall).

**NOTE:** 100% compatible with older chocolatey client (0.9.8.32 and below)
with options and switches. Add `-y` for previous behavior with no
Expand Down
2 changes: 1 addition & 1 deletion CommandsUpdate.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

**NOTE:** Update has been deprecated and will be removed/replaced in version
1.0.0 with something that performs the functions of updating package
indexes. Please use [[`choco upgrade`|Commandsupgrade]] instead.
indexes. Please use [`choco upgrade`](CommandsUpgrade) instead.

<!-- TOC -->

Expand Down
4 changes: 2 additions & 2 deletions CommandsUpgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Upgrade Command (choco upgrade)

Upgrades a package or a list of packages. Some may prefer to use `cup`
as a shortcut for [[`choco upgrade`|Commandsupgrade]]. If you do not have a package
as a shortcut for [`choco upgrade`](CommandsUpgrade). If you do not have a package
installed, upgrade will install it.

**NOTE:** 100% compatible with older Chocolatey client (0.9.8.x and below)
Expand All @@ -29,7 +29,7 @@ Upgrades a package or a list of packages. Some may prefer to use `cup`
**NOTE:** `all` is a special package keyword that will allow you to upgrade
all currently installed packages.

Skip upgrading certain packages with [[`choco pin`|Commandspin]] or with the option
Skip upgrading certain packages with [`choco pin`](CommandsPin) or with the option
`--except`.

**NOTE:** [Chocolatey Pro](https://chocolatey.org/compare) / Business automatically synchronizes with
Expand Down
2 changes: 1 addition & 1 deletion CommandsVersion.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
`choco list -lo`.

If you want to know what has available upgrades, use
`choco upgrade <pkg|all> -whatif` or [[`choco outdated`|Commandsoutdated]].
`choco upgrade <pkg|all> -whatif` or [`choco outdated`](CommandsOutdated).

<!-- TOC -->

Expand Down
2 changes: 1 addition & 1 deletion CreatePackages.md
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ Example: In the case of `Bob.exe` you would create a file named `Bob.exe.gui` an
## Build Your Package
Open a command line in the directory where the nuspec is and type [[`choco pack`|CommandsPack]]. That's it.
Open a command line in the directory where the nuspec is and type [`choco pack`](CommandsPack). That's it.
## Testing Your Package
Expand Down
2 changes: 1 addition & 1 deletion HelpersInstallChocolateyDesktopLink.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ method as this has been deprecated.

## Notes

Deprecated in favor of [[`Install-ChocolateyShortcut`|HelpersInstallChocolateyShortcut]].
Deprecated in favor of [`Install-ChocolateyShortcut`](HelpersInstallChocolateyShortcut).
If this errors, such as it will if being installed under the local
SYSTEM account, it will display a warning instead of failing a package
installation.
Expand Down
2 changes: 1 addition & 1 deletion How-To-Create-Custom-Package-Templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ As of [choco 0.9.9.9](https://github.com/chocolatey/choco/issues/76), you can cr
<!-- /TOC -->

## Overview
A template is used for creating packages. Chocolatey (choco) has a built-in template that it uses when generating a new package from the command [[`choco new`|CommandsNew]].
A template is used for creating packages. Chocolatey (choco) has a built-in template that it uses when generating a new package from the command [`choco new`](CommandsNew).

### Where Do Templates Go?

Expand Down

0 comments on commit 4184f8e

Please sign in to comment.