diff --git a/docs/api.md b/docs/api.md index b8589016..6e0de859 100644 --- a/docs/api.md +++ b/docs/api.md @@ -16,7 +16,7 @@ https://nuget.org/packages/MarkdownSnippets/ [![NuGet Status](https://img.shield ## Reading snippets from files - + ```cs var files = Directory.EnumerateFiles(@"C:\path", "*.cs", SearchOption.AllDirectories); @@ -29,7 +29,7 @@ var snippets = FileSnippetExtractor.Read(files); ## Reading snippets from a directory structure - + ```cs // extract snippets from files var snippetExtractor = new DirectorySnippetExtractor( @@ -45,7 +45,7 @@ var snippets = snippetExtractor.ReadSnippets(@"C:\path"); ## Full Usage - + ```cs var directory = @"C:\path"; diff --git a/docs/config-file.md b/docs/config-file.md index e04bb2a1..704c4267 100644 --- a/docs/config-file.md +++ b/docs/config-file.md @@ -12,7 +12,7 @@ The [dotnet tool](/readme.md#installation) and the [MSBuild Task](msbuild.md) su Add a file named `mdsnippets.json` at the target directory with the following content: - + ```json { "ReadOnly": false, diff --git a/docs/github-action.md b/docs/github-action.md index e9bec69d..7ca50238 100644 --- a/docs/github-action.md +++ b/docs/github-action.md @@ -12,7 +12,7 @@ Markdown snippets can be run inside a [GitHub Action](https://help.github.com/en Add the following to `.github\workflows\on-push-do-doco.yml` in the target repository. - + ```yml name: on-push-do-docs on: diff --git a/docs/header.md b/docs/header.md index aac14ae1..bc2a7456 100644 --- a/docs/header.md +++ b/docs/header.md @@ -10,7 +10,7 @@ To change this file edit the source file and then run MarkdownSnippets. When a .md file is written, a header is include. The default header is: - + ```txt GENERATED FILE - DO NOT EDIT This file was generated by [MarkdownSnippets](https://github.com/SimonCropp/MarkdownSnippets). diff --git a/docs/max-width.md b/docs/max-width.md index 88de13f3..67280fe4 100644 --- a/docs/max-width.md +++ b/docs/max-width.md @@ -32,7 +32,7 @@ The Max Width setting is used to control the maximum characters per line of a sn ### Code Api - + ```cs var processor = new DirectoryMarkdownProcessor( "targetDirectory", diff --git a/docs/toc.md b/docs/toc.md index 3242fef3..e5276a6d 100644 --- a/docs/toc.md +++ b/docs/toc.md @@ -12,7 +12,7 @@ If a line is `toc` it will be replaced with a table of contents So if a markdown document contains the following: - + ```txt # Title @@ -32,7 +32,7 @@ Text2 The result will be rendered: - + ```txt # Title diff --git a/readme.md b/readme.md index ab4e5991..91dfafb7 100644 --- a/readme.md +++ b/readme.md @@ -125,7 +125,7 @@ The resulting markdown will be: Some blurb about the below snippet - + ``` My Snippet Code ``` @@ -143,7 +143,7 @@ Notes: Defines the format of `snippet source` links that appear under each snippet. - + ```cs namespace MarkdownSnippets { @@ -160,7 +160,7 @@ namespace MarkdownSnippets - + ```cs if (linkFormat == LinkFormat.GitHub) { diff --git a/readme.source.md b/readme.source.md index c1bf3074..46d66463 100644 --- a/readme.source.md +++ b/readme.source.md @@ -109,7 +109,7 @@ The resulting markdown will be: Some blurb about the below snippet - + ``` My Snippet Code ``` diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 66993f62..a587dc09 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -2,7 +2,7 @@ CS1591 - 19.1.3 + 19.1.4 1.0.0 Markdown, Snippets, mdsnippets, documentation, MarkdownSnippets Extracts snippets from code files and merges them into markdown documents. diff --git a/src/MarkdownSnippets/Processing/SnippetMarkdownHandling.cs b/src/MarkdownSnippets/Processing/SnippetMarkdownHandling.cs index 818d04b0..ba2481cb 100644 --- a/src/MarkdownSnippets/Processing/SnippetMarkdownHandling.cs +++ b/src/MarkdownSnippets/Processing/SnippetMarkdownHandling.cs @@ -40,7 +40,7 @@ void WriteSnippet(Action appendLine, Snippet snippet, uint index) { var anchor = GetAnchorText(snippet, index); - appendLine($""); + appendLine($""); WriteSnippetValueAndLanguage(appendLine, snippet); if (TryGetSupText(snippet,anchor, out var supText)) diff --git a/src/Tests/DirectoryMarkdownProcessorTests.Convention.verified.txt b/src/Tests/DirectoryMarkdownProcessorTests.Convention.verified.txt index f2417e12..970738cb 100644 --- a/src/Tests/DirectoryMarkdownProcessorTests.Convention.verified.txt +++ b/src/Tests/DirectoryMarkdownProcessorTests.Convention.verified.txt @@ -1,6 +1,6 @@ \one.md - + ```.cs the code from snippet1 ``` @@ -13,7 +13,7 @@ snippet: snippet1 \two.md - + ```.cs the code from snippet2 ``` diff --git a/src/Tests/DirectoryMarkdownProcessorTests.NonMd.verified.txt b/src/Tests/DirectoryMarkdownProcessorTests.NonMd.verified.txt index 35f04359..3aac094d 100644 --- a/src/Tests/DirectoryMarkdownProcessorTests.NonMd.verified.txt +++ b/src/Tests/DirectoryMarkdownProcessorTests.NonMd.verified.txt @@ -3,7 +3,7 @@ snippet: snippet1 \one.txt - + ```.cs the code from snippet1 ``` @@ -13,7 +13,7 @@ the code from snippet1 \two.txt - + ```.cs the code from snippet2 ``` diff --git a/src/Tests/DirectoryMarkdownProcessorTests.UrlSnippet.verified.txt b/src/Tests/DirectoryMarkdownProcessorTests.UrlSnippet.verified.txt index 7139cb3f..3bf8dcc2 100644 --- a/src/Tests/DirectoryMarkdownProcessorTests.UrlSnippet.verified.txt +++ b/src/Tests/DirectoryMarkdownProcessorTests.UrlSnippet.verified.txt @@ -1,5 +1,5 @@ - + ```txt The MIT License (MIT) diff --git a/src/Tests/SnippetMarkdownHandlingTests.AppendGroup.verified.txt b/src/Tests/SnippetMarkdownHandlingTests.AppendGroup.verified.txt index 0d3b9be2..91c5c7dd 100644 --- a/src/Tests/SnippetMarkdownHandlingTests.AppendGroup.verified.txt +++ b/src/Tests/SnippetMarkdownHandlingTests.AppendGroup.verified.txt @@ -1,4 +1,4 @@ - + ```thelanguage theValue ```