Skip to content

Commit

Permalink
dotnet-cstomd release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
maximv committed Aug 28, 2020
1 parent ee60648 commit fafe09b
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 9 deletions.
2 changes: 1 addition & 1 deletion CsToMd/ReleaseNotes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
## v1.2.0 - Feature release

- added: #3 Make it to dotnet CLI tool (dotnet-cstomd)
- added: #4 Ability to remove specific lines from the md output #4
- added: #4 Ability to remove specific lines from the md output (cstomd.config)
- added: #6 Add the special comments to wrap the section into collapsible details enhancement
- added: #7 Strip the comment from the line with `//md` enhancement
13 changes: 7 additions & 6 deletions CsToMdDotnetTool/CsToMdDotnetTool.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
<ToolCommandName>cstomd</ToolCommandName>
<AssemblyName>cstomd</AssemblyName>
<PackageId>dotnet-cstomd</PackageId>
<VersionPrefix>1.0.0</VersionPrefix>
<VersionSuffix>preview-04</VersionSuffix>
<VersionPrefix>1.2.0</VersionPrefix>
<VersionSuffix></VersionSuffix>
<PackageOutputPath>..\.nupkg</PackageOutputPath>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<Authors>Maksim Volkau</Authors>
Expand All @@ -23,12 +23,13 @@
<PackageTags>cli dotnet dotnet-tool csharp tests markdown documentation live-documentation literate-programming</PackageTags>
<PackageReleaseNotes>
<![CDATA[
## v1.0.0
Initial version
## v1.2.0 - Feature release
- Converting (copying) a single file with any extension
- Support for the optional configuration file to remove the lines started with the lines in the config file
- added: #3 Make it to dotnet CLI tool (dotnet-cstomd)
- added: #4 Ability to remove specific lines from the md output (cstomd.config)
- added: #6 Add the special comments to wrap the section into collapsible details enhancement
- added: #7 Strip the comment from the line with `//md` enhancement
]]>
</PackageReleaseNotes>
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Visual Studio extension to generate a Markdown .md documentation file from the C# .cs file stripping the special symbol comments.

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

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

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

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.
Expand Down

0 comments on commit fafe09b

Please sign in to comment.