Fixes formatting for docs

Unfortunately, three tildes works as "cross-out" in GFM, and not as "code-sample".
As a result, this was breaking the formatting and layout of the bottom of the page.
To fix this I have simplified the NuGet Package Manager code sample to use the standard GFM "code" convention.
This commit is contained in:
Pat Hermens
2017-05-02 09:11:12 +02:00
committed by GitHub
parent e0fa82175b
commit b62fb9dd96

View File

@@ -10,7 +10,13 @@ Squirrel packaging can be easily integrated directly into your build process usi
The first step is to define a build target in your `.csproj` file.
```xml
<Target Name="AfterBuild" Condition=" '$(Configuration)' == 'Release'">
<Target Name="AfterBuild" Condition=" '$(Configuration)' == 'Release'">
<GetAssemblyIdentity AssemblyFiles="$(TargetPath)">
<Output TaskParameter="Assemblies" ItemName="myAssemblyInfo"/>
</GetAssemblyIdentity>
<Exec Command="nuget pack MyApp.nuspec -Version %(myAssemblyInfo.Version) -Properties Configuration=Release -OutputDirectory $(OutDir) -BasePath $(OutDir)" />
<Exec Command="squirrel --releasify $(OutDir)MyApp.%(myAssemblyInfo.Version).nupkg" />
</Target>
```
This will generate a NuGet package from .nuspec file setting version from AssemblyInfo.cs and place it in OutDir (by default bin\Release). Then it will generate release files from it.
@@ -20,7 +26,23 @@ This will generate a NuGet package from .nuspec file setting version from Assemb
Here is an example `MyApp.nuspec` file for the above build target example.
```xml
<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
<metadata>
<id>MyApp</id>
<!-- version will be replaced by MSBuild -->
<version>0.0.0.0</version>
<title>title</title>
<authors>authors</authors>
<description>description</description>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<copyright>Copyright 2016</copyright>
<dependencies />
</metadata>
<files>
<file src="*.*" target="lib\net45\" exclude="*.pdb;*.nupkg;*.vshost.*"/>
</files>
</package>
```
## Additional Notes
@@ -29,9 +51,10 @@ Please be aware of the following when using this solution:
* Solution needs to have nuget.exe available which can be accomplished by installing `NuGet.CommandLine` package in your solution.
<id>MyApp</id>
```pm
PM> Install-Package NuGet.CommandLine
<version>0.0.0.0</version>
```
* It suffers from a bug when sometimes NuGet packages are not loaded properly and throws nuget/squirrel is not recogized (9009) errors.
**Tip:** In this case you may simply need to restart Visual Studio so the Package Manager Console will have loaded all the package tools
* If you get the following error you may need add the full path to squirrel.exe in the build target `Exec Command` call. `'squirrel' is not recognized as an internal or external command`