Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@SimonCropp
SimonCropp committed Oct 14, 2024
1 parent 0af5709 commit 0f4b5d0
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
6 changes: 4 additions & 2 deletions readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ To change this file edit the source file and then run MarkdownSnippets.
[![NuGet Status](https://img.shields.io/nuget/v/MarkdownSnippets.MsBuild.svg?label=MsBuild%20Task)](https://www.nuget.org/packages/MarkdownSnippets.MsBuild/)
[![NuGet Status](https://img.shields.io/nuget/v/MarkdownSnippets.svg?label=.net%20API)](https://www.nuget.org/packages/MarkdownSnippets/)

A [dotnet tool](https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools) that extract snippets from code files and merges them into markdown documents.
A [dotnet tool](https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools) or [MsBuild Task](/docs/msbuild.md) that extract snippets from code files and merges them into markdown documents.

**See [Milestones](../../milestones?state=closed) for release notes.**

**[.net 8](https://dotnet.microsoft.com/download/dotnet/8.0) or higher is required to run this tool.**
**[.net 8](https://dotnet.microsoft.com/download/dotnet/8.0) or higher is required to run the dotnet tool.**


## Value Proposition
Expand Down Expand Up @@ -47,6 +47,8 @@ Install [MarkdownSnippets.Tool](https://nuget.org/packages/MarkdownSnippets.Tool
dotnet tool install -g MarkdownSnippets.Tool
```

See also: [MsBuild Task usage](/docs/msbuild.md)


## Usage

Expand Down
6 changes: 4 additions & 2 deletions readme.source.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
[![NuGet Status](https://img.shields.io/nuget/v/MarkdownSnippets.MsBuild.svg?label=MsBuild%20Task)](https://www.nuget.org/packages/MarkdownSnippets.MsBuild/)
[![NuGet Status](https://img.shields.io/nuget/v/MarkdownSnippets.svg?label=.net%20API)](https://www.nuget.org/packages/MarkdownSnippets/)

A [dotnet tool](https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools) that extract snippets from code files and merges them into markdown documents.
A [dotnet tool](https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools) or [MsBuild Task](/docs/msbuild.md) that extract snippets from code files and merges them into markdown documents.

**See [Milestones](../../milestones?state=closed) for release notes.**

**[.net 8](https://dotnet.microsoft.com/download/dotnet/8.0) or higher is required to run this tool.**
**[.net 8](https://dotnet.microsoft.com/download/dotnet/8.0) or higher is required to run the dotnet tool.**


## Value Proposition
Expand Down Expand Up @@ -40,6 +40,8 @@ Install [MarkdownSnippets.Tool](https://nuget.org/packages/MarkdownSnippets.Tool
dotnet tool install -g MarkdownSnippets.Tool
```

See also: [MsBuild Task usage](/docs/msbuild.md)


## Usage

Expand Down

0 comments on commit 0f4b5d0

Please sign in to comment.