Markdown Converter is a C# project that allows you to convert markdown file into html.
- Clone the repo to your local machine:
git clone https://github.com/dmykyr/Markdown-converter.git- Restore the .NET packages:
dotnet restore- Build the project:
dotnet build- Run the project with the path to the markdown file as an argument:
dotnet run <path-to-markdown-file>- If you want to write the output to a file, use --out option followed by the output file path:
--out <output-file-path>If --out option is provided, default output format is HTML
- To specify output format (ansi or html), use --format option followed by the format:
--format <format>If neither --format nor --out options are provided, default format is ANSI.
To run tests, follow these steps:
-
Navigate to the project directory in your terminal.
-
Run the following command to execute the tests:
dotnet testThis will run all test cases and display the results in the terminal. Here is possible example how result can look like:
Passed! - Failed: 0, Passed: 12, Skipped: 0, Total: 12, Duration: 17 ms - MarkdownConverter.dll (net8.0)In such a project, tests might not seem important, because most of the use cases can be checked through debugging But in larger projects, tests are very useful and helpful. I implemented some of the integration and unit tests in ficeAdvisor as part of our milestone to cover services with tests and it helped a lot later. These tests were useful while we were updating and rewriting services methods. I think keeping tests up-to-date in such projects is important and neccessary. They not only minimize the time spent on code inspection and debugging for developer but also helps to avoid human factor during code review.