Skip to content

Commit

Permalink
Fix Markdownlint errors (#11620)
Browse files Browse the repository at this point in the history
  • Loading branch information
scottaddie committed Mar 21, 2019
1 parent 12396a9 commit ed28cd5
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 18 deletions.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Articles are written in [DocFx-flavored Markdown](https://dotnet.github.io/docfx

For each Markdown file, a folder for images and a folder for sample code may exist. If the article is [fundamentals/configuration/index.md](https://github.com/aspnet/Docs/blob/master/aspnetcore/fundamentals/configuration/index.md), the images are in [fundamentals/configuration/index/\_static](https://github.com/aspnet/Docs/tree/master/aspnetcore/fundamentals/configuration/index/_static) and the sample app project files are in [fundamentals/configuration/index/sample](https://github.com/aspnet/Docs/tree/master/aspnetcore/fundamentals/configuration/index/sample). An image in the *fundamentals/configuration/index.md* file is rendered by the following Markdown:

```
```md
![description of image for alt attribute](configuration/index/_static/imagename.png)
```

Expand All @@ -42,13 +42,13 @@ Use lowercase for Markdown file names and image file names.

Internal links should use the `uid` of the target article with an xref link (link text is set to the linked content's title):

```
```md
<xref:uid_of_the_topic>
```

If the title of the article is unsuitable for link text (for example, a word or phrase in a sentence is the link text), specify the xref link and link text with the following:

```
```md
[link text](xref:uid_of_the_topic)
```

Expand All @@ -73,13 +73,13 @@ The following examples illustrate [DFM code snippet syntax](https://dotnet.githu

To render an entire code file as a snippet:

```
```md
[!code-csharp[](configuration/index/sample/Program.cs)]
```

To render a portion of a file as a snippet by using line numbers:

```
```md
[!code-csharp[](configuration/index/sample/Program.cs?range=1-10,20,30,40-50]
[!code-html[](configuration/index/sample/Views/Home/Index.cshtml?range=1-10,20,30,40-50]
```
Expand All @@ -88,13 +88,13 @@ For C# snippets, reference a [C# region](https://docs.microsoft.com/dotnet/cshar

To render a C# region named "snippet_Example":

```
```md
[!code-csharp[](configuration/index/sample/Program.cs?name=snippet_Example)]
```

To highlight selected lines in a rendered snippet (usually renders as yellow background color):

```
```md
[!code-csharp[](configuration/index/sample/Program.cs?name=snippet_Example&highlight=1-3,10,20-25)]
[!code-csharp[](configuration/index/sample/Program.cs?range=10-20&highlight=1-3]
[!code-html[](configuration/index/sample/Views/Home/Index.cshtml?range=10-20&highlight=1-3]
Expand Down
4 changes: 2 additions & 2 deletions aspnetcore/fundamentals/localization.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ A French resource file could contain the following:

| Key | Value |
| ----- | ------ |
| `<i>Hello</i> <b>{0}!</b>` | `<i>Bonjour</i> <b>{0} !</b> ` |
| `<i>Hello</i> <b>{0}!</b>` | `<i>Bonjour</i> <b>{0} !</b>` |

The rendered view would contain the HTML markup from the resource file.

Expand Down Expand Up @@ -168,7 +168,7 @@ If the root namespace of an assembly is different than the assembly name:

If the `RootNamespace` is different from the `AssemblyName`, include the following in *AssemblyInfo.cs* (with parameter values replaced with the actual values):

```Csharp
```csharp
using System.Reflection;
using Microsoft.Extensions.Localization;

Expand Down
12 changes: 6 additions & 6 deletions aspnetcore/includes/scaffold-identity/id-scaffold-dlg-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,32 +23,32 @@ Note: If you're creating a new user context, you don't have to select a file to

If you have not previously installed the ASP.NET Core scaffolder, install it now:

```cli
```console
dotnet tool install -g dotnet-aspnet-codegenerator
```

Add a package reference to [Microsoft.VisualStudio.Web.CodeGeneration.Design](https://www.nuget.org/packages/Microsoft.VisualStudio.Web.CodeGeneration.Design/) to the project (\*.csproj) file. Run the following command in the project directory:

```cli
```console
dotnet add package Microsoft.VisualStudio.Web.CodeGeneration.Design
dotnet restore
```

Run the following command to list the Identity scaffolder options:

```cli
```console
dotnet aspnet-codegenerator identity -h
```

In the project folder, run the Identity scaffolder with the options you want. For example, to setup identity with the default UI and the minimum number of files, run the following command. Use the correct fully qualified name for your DB context:

```cli
```console
dotnet aspnet-codegenerator identity -dc MyWeb.Data.ApplicationDbContext --files Account.Register
```

Powershell uses semicolon as a command separator. When using powershell, escape the semi-colons in the file list or put the file list in double quotes. For example:
PowerShell uses semicolon as a command separator. When using PowerShell, escape the semi-colons in the file list or put the file list in double quotes. For example:

```cli
```console
dotnet aspnet-codegenerator identity -dc MyWeb.Data.ApplicationDbContext --files "Account.Register;Account.Login;Account.Logout"
```

Expand Down
1 change: 1 addition & 0 deletions aspnetcore/signalr/hubs.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ You can specify a return type and parameters, including complex types and arrays

> [!NOTE]
> Hubs are transient:
>
> * Don't store state in a property on the hub class. Every hub method call is executed on a new hub instance.
> * Use `await` when calling asynchronous methods that depend on the hub staying alive. For example, a method such as `Clients.All.SendAsync(...)` can fail if it's called without `await` and the hub method completes before `SendAsync` finishes.
Expand Down
2 changes: 1 addition & 1 deletion aspnetcore/test/integration-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ Call the [UseSolutionRelativeContentRoot](/dotnet/api/microsoft.aspnetcore.testh

## Disable shadow copying

Shadow copying causes the tests to execute in a different folder than the output folder. For tests to work properly, shadow copying must be disabled. The [sample app](https://github.com/aspnet/Docs/tree/master/aspnetcore/test/integration-tests/samples) uses xUnit and disables shadow copying for xUnit by including an *xunit.runner.json* file with the correct configuration setting. For more information, see [Configuring xUnit.net with JSON](https://xunit.github.io/docs/configuring-with-json.html).
Shadow copying causes the tests to execute in a different folder than the output folder. For tests to work properly, shadow copying must be disabled. The [sample app](https://github.com/aspnet/Docs/tree/master/aspnetcore/test/integration-tests/samples) uses xUnit and disables shadow copying for xUnit by including an *xunit.runner.json* file with the correct configuration setting. For more information, see [Configuring xUnit with JSON](https://xunit.github.io/docs/configuring-with-json.html).
Add the *xunit.runner.json* file to root of the test project with the following content:

Expand Down
2 changes: 1 addition & 1 deletion aspnetcore/tutorials/first-mvc-app/adding-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ Open the *Controllers/MoviesController.cs* file and examine the constructor:

[!code-csharp[](~/tutorials/first-mvc-app/start-mvc/sample/MvcMovie22/Controllers/MC1.cs?name=snippet_1)]

The constructor uses [Dependency Injection](xref:fundamentals/dependency-injection) to inject the database context (`MvcMovieContext `) into the controller. The database context is used in each of the [CRUD](https://wikipedia.org/wiki/Create,_read,_update_and_delete) methods in the controller.
The constructor uses [Dependency Injection](xref:fundamentals/dependency-injection) to inject the database context (`MvcMovieContext`) into the controller. The database context is used in each of the [CRUD](https://wikipedia.org/wiki/Create,_read,_update_and_delete) methods in the controller.

<a name="strongly-typed-models-keyword-label"></a>
<a name="strongly-typed-models-and-the--keyword"></a>
Expand Down
2 changes: 1 addition & 1 deletion aspnetcore/tutorials/razor-pages/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ The scaffolding engine creates Razor markup for each field in the model (except

[!code-cshtml[](~/tutorials/razor-pages/razor-pages-start/snapshot_sample/RazorPagesMovie/Pages/Movies/Create.cshtml?range=15-20)]

The [Validation Tag Helpers](xref:mvc/views/working-with-forms#the-validation-tag-helpers) (`<div asp-validation-summary` and ` <span asp-validation-for`) display validation errors. Validation is covered in more detail later in this series.
The [Validation Tag Helpers](xref:mvc/views/working-with-forms#the-validation-tag-helpers) (`<div asp-validation-summary` and `<span asp-validation-for`) display validation errors. Validation is covered in more detail later in this series.

The [Label Tag Helper](xref:mvc/views/working-with-forms#the-label-tag-helper) (`<label asp-for="Movie.Title" class="control-label"></label>`) generates the label caption and `for` attribute for the `Title` property.

Expand Down

0 comments on commit ed28cd5

Please sign in to comment.