From dbc35f7ed17e48954325f331a252e27fb3e7180a Mon Sep 17 00:00:00 2001 From: Maksim Volkau Date: Fri, 25 Sep 2020 20:43:28 +0300 Subject: [PATCH 01/10] fix the readme Build Integration section --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ce609d6..84bc047 100644 --- a/README.md +++ b/README.md @@ -66,8 +66,8 @@ I addition the dotnet tool enables the documentation development in the **Visual * Switch to your project: `cd path\to\MyProject` * Add the tool manifest file: `dotnet new tool-manifest` - * Install the tool: `dotnet tool install --global dotnet-cstomd --version 1.2.1` (the manifest file will be updated and later used for restore) - * Add the section to you project: + * Install the tool: `dotnet tool install dotnet-cstomd --version 1.2.1` (the manifest file will be updated and later used for restore) + * Add the section to your project: ```xml From 9ae9745ca86d619033be50f59c5d8eec0d88fdea Mon Sep 17 00:00:00 2001 From: Maksim Volkau Date: Fri, 25 Sep 2020 20:46:24 +0300 Subject: [PATCH 02/10] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 84bc047..3dfbed2 100644 --- a/README.md +++ b/README.md @@ -80,11 +80,11 @@ I addition the dotnet tool enables the documentation development in the **Visual ``` You may check the DryIoc [documentation project file](https://github.com/dadhi/DryIoc/blob/6f466ee1b4fde548c7211ecb0a54655011f69e57/docs/DryIoc.Docs/DryIoc.Docs.csproj#L26) for the real-world case example. - * You may run the document generation target without the rest the build: + * You may run the document generation target without the rest of the build: ``` dotnet msbuild -target:MdGenerate path\to\MyProject\MyProject.csproj ``` - You may create a helper `build_the_docs` file and store the command there. + You may create a helper shell script `build_the_docs` with the command above. Here is the [MS tutorial](https://docs.microsoft.com/en-us/dotnet/core/tools/local-tools-how-to-use#:~:text=Create%20a%20manifest%20file,-To%20install%20a&text=The%20output%20indicates%20successful%20creation%20of%20the%20file.&text=The%20template%20%22Dotnet%20local%20tool%20manifest%20file%22%20was%20created%20successfully.&text=The%20tools%20listed%20in%20a,the%20one%20that%20contains%20the%20.) for installing and using the local tools. From b2f5af31cf7d1e42150697b9508f5b15ccd785b4 Mon Sep 17 00:00:00 2001 From: Maksim Volkau Date: Thu, 8 Oct 2020 23:29:10 +0300 Subject: [PATCH 03/10] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3dfbed2..6ce1fa5 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ You may check the DryIoc [documentation project](https://github.com/dadhi/DryIoc The additional features in v1.2.0: -- Converting the section outlined with `//md{` and `//md}` comments int the [collapsed markdown details](https://gist.github.com/pierrejoubert73/902cc94d79424356a8d20be2b382e1ab). +- Converting the section outlined with `//md{` and `//md}` comments into the [collapsed markdown details](https://gist.github.com/pierrejoubert73/902cc94d79424356a8d20be2b382e1ab). - The optional `cstomd.config` file in the folder with the lines starters to be removed completely from the generated documentation file. From ffa73911eeb0b25f7a9a812e0f9b61df53c666fb Mon Sep 17 00:00:00 2001 From: Maksim Volkau Date: Thu, 8 Oct 2020 23:31:23 +0300 Subject: [PATCH 04/10] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6ce1fa5..47fb94b 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ The generated result: ## Dotnet CLI tool -The [dotnet-cstomd](https://www.nuget.org/packages/dotnet-cstomd) is a [dotnet CLI tool](https://docs.microsoft.com/en-us/dotnet/core/tools/) providing the same functionality as a Visual Studio extension plus it may be called from the command line and from the MSBuild scripts (**enabling the document generation in the build pipeline**). +The [dotnet-cstomd](https://www.nuget.org/packages/dotnet-cstomd) is a [dotnet CLI tool](https://docs.microsoft.com/en-us/dotnet/core/tools/) providing the same functionality as a Visual Studio extension plus it may be called from the command line and from the MSBuild **enabling the document generation in the build pipeline**. I addition the dotnet tool enables the documentation development in the **Visual Studio Code**. From 245fee398370df56a7dcabfba379c9f6b18a0277 Mon Sep 17 00:00:00 2001 From: Maksim Volkau Date: Thu, 8 Oct 2020 23:32:20 +0300 Subject: [PATCH 05/10] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 47fb94b..91594e3 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ The generated result: The [dotnet-cstomd](https://www.nuget.org/packages/dotnet-cstomd) is a [dotnet CLI tool](https://docs.microsoft.com/en-us/dotnet/core/tools/) providing the same functionality as a Visual Studio extension plus it may be called from the command line and from the MSBuild **enabling the document generation in the build pipeline**. -I addition the dotnet tool enables the documentation development in the **Visual Studio Code**. +In addition the dotnet tool enables the documentation development in the **Visual Studio Code**. ![VSCode usage](screen3.png) From d42a2d22263a4d1f7659624aac16acf9df0aa5e2 Mon Sep 17 00:00:00 2001 From: Maksim Volkau Date: Thu, 8 Oct 2020 23:33:33 +0300 Subject: [PATCH 06/10] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 91594e3..b9d4300 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ In addition the dotnet tool enables the documentation development in the **Visua ``` dotnet msbuild -target:MdGenerate path\to\MyProject\MyProject.csproj ``` - You may create a helper shell script `build_the_docs` with the command above. + You may create a helper shell script with the command above. Here is the [MS tutorial](https://docs.microsoft.com/en-us/dotnet/core/tools/local-tools-how-to-use#:~:text=Create%20a%20manifest%20file,-To%20install%20a&text=The%20output%20indicates%20successful%20creation%20of%20the%20file.&text=The%20template%20%22Dotnet%20local%20tool%20manifest%20file%22%20was%20created%20successfully.&text=The%20tools%20listed%20in%20a,the%20one%20that%20contains%20the%20.) for installing and using the local tools. From 33beffb26c0636d8e0e36251b9a0005cefb50856 Mon Sep 17 00:00:00 2001 From: dadhi Date: Wed, 2 Mar 2022 19:08:48 +0100 Subject: [PATCH 07/10] adding Sponsor button --- .github/FUNDING.yml | 1 + 1 file changed, 1 insertion(+) create mode 100644 .github/FUNDING.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..768a754 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +github: dadhi \ No newline at end of file From b27f8a742e12f24cd069fc31d5e7a8dd46e26331 Mon Sep 17 00:00:00 2001 From: dadhi Date: Wed, 2 Mar 2022 20:15:58 +0100 Subject: [PATCH 08/10] updating licinse year --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 5465913..d0d9a6a 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2018-2020 Maksim Volkau +Copyright (c) 2018-2022 Maksim Volkau Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal From ea3ef860d027b7944a204bc0de09b9fcca609c8f Mon Sep 17 00:00:00 2001 From: dadhi Date: Wed, 2 Mar 2022 20:16:23 +0100 Subject: [PATCH 09/10] updating readme --- README.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b9d4300..57a63da 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,11 @@ # CsToMd -- [CsToMd](#cstomd) - - [Overview](#overview) - - [Visual Studio extension](#visual-studio-extension) - - [How to use](#how-to-use) - - [Dotnet CLI tool](#dotnet-cli-tool) - - [Ad-hoc document generation](#ad-hoc-document-generation) - - [Build integration](#build-integration) - -## Overview +![stand with Ukraine](https://badgen.net/badge/stand%20with/UKRAINE/?color=0057B8&labelColor=FFD700) [![NuGet Badge](https://buildstats.info/nuget/dotnet-cstomd)](https://www.nuget.org/packages/dotnet-cstomd) +## Overview + The [dotnet CLI tool](https://www.nuget.org/packages/dotnet-cstomd) and [Visual Studio extension](https://marketplace.visualstudio.com/items?itemName=dadhi.cstomd123) to generate the [Markdown](https://guides.github.com/features/mastering-markdown) documentation file from the C# file. **The idea** is to have a normal C# .cs file with the special comments `/*md`, `md*/`, and `//md` which will be stripped when converting the file into the respective Markdown .md file. There are couple of additional features but this is basically it. From 4ea45e0a0f36d6eaf7711c8d686ec4f25a7cdc8c Mon Sep 17 00:00:00 2001 From: Maksim Volkau Date: Fri, 11 Aug 2023 20:20:37 +0200 Subject: [PATCH 10/10] Update README.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 57a63da..e9d1ce8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # CsToMd -![stand with Ukraine](https://badgen.net/badge/stand%20with/UKRAINE/?color=0057B8&labelColor=FFD700) - [![NuGet Badge](https://buildstats.info/nuget/dotnet-cstomd)](https://www.nuget.org/packages/dotnet-cstomd) ## Overview