Skip to content

Commit fafe09b

Browse files
author
maximv
committed
dotnet-cstomd release notes
1 parent ee60648 commit fafe09b

File tree

3 files changed

+10
-9
lines changed

3 files changed

+10
-9
lines changed

CsToMd/ReleaseNotes.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
## v1.2.0 - Feature release
44

55
- added: #3 Make it to dotnet CLI tool (dotnet-cstomd)
6-
- added: #4 Ability to remove specific lines from the md output #4
6+
- added: #4 Ability to remove specific lines from the md output (cstomd.config)
77
- added: #6 Add the special comments to wrap the section into collapsible details enhancement
88
- added: #7 Strip the comment from the line with `//md` enhancement

CsToMdDotnetTool/CsToMdDotnetTool.csproj

+7-6
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
<ToolCommandName>cstomd</ToolCommandName>
88
<AssemblyName>cstomd</AssemblyName>
99
<PackageId>dotnet-cstomd</PackageId>
10-
<VersionPrefix>1.0.0</VersionPrefix>
11-
<VersionSuffix>preview-04</VersionSuffix>
10+
<VersionPrefix>1.2.0</VersionPrefix>
11+
<VersionSuffix></VersionSuffix>
1212
<PackageOutputPath>..\.nupkg</PackageOutputPath>
1313
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
1414
<Authors>Maksim Volkau</Authors>
@@ -23,12 +23,13 @@
2323
<PackageTags>cli dotnet dotnet-tool csharp tests markdown documentation live-documentation literate-programming</PackageTags>
2424
<PackageReleaseNotes>
2525
<![CDATA[
26-
## v1.0.0
2726
28-
Initial version
27+
## v1.2.0 - Feature release
2928
30-
- Converting (copying) a single file with any extension
31-
- Support for the optional configuration file to remove the lines started with the lines in the config file
29+
- added: #3 Make it to dotnet CLI tool (dotnet-cstomd)
30+
- added: #4 Ability to remove specific lines from the md output (cstomd.config)
31+
- added: #6 Add the special comments to wrap the section into collapsible details enhancement
32+
- added: #7 Strip the comment from the line with `//md` enhancement
3233
3334
]]>
3435
</PackageReleaseNotes>

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Visual Studio extension to generate a Markdown .md documentation file from the C# .cs file stripping the special symbol comments.
44

55
This VSIX extension for Visual Studio 2019 contains a CustomTool File Generator,
6-
which generates a markdown file from the .cs file by stripping the comments `/*md` and `md*/`.
6+
which generates a markdown file from the .cs file by stripping the comments `/*md`, `md*/`, and `//md`.
77

88
**The tool helps to turn your C# file with markdown comments into documentation file with runnable examples and what not.**
99

@@ -22,7 +22,7 @@ which generates a markdown file from the .cs file by stripping the comments `/*m
2222
- Clone this repo, compile *CsToMd* project, find the *CsToMd.vsix* in output and install it.
2323
__Or simply install__ a `vsix` extension from the [release](https://github.com/dadhi/CsToMd/releases/tag/1.0.0-preview-01).
2424
- In properties of your .cs file, set the `CustomTool` property to `CsToMd`.
25-
- Save the .cs file with `/*md` and `md*/` commnents in it (or without - it will work too).
25+
- Save the .cs file with `/*md` and `md*/` comments in it (or without - it will work too).
2626
- Check the generated .md file under the .cs file in Solution Explorer
2727

2828
Play with the example project [CsToMdTest](https://github.com/dadhi/CsToMd/tree/1.0.0-preview-01/CsToMdTest) in this repo to see how it works.

0 commit comments

Comments
 (0)