MarkdownToDocxGenerator 1.1.0

MarkdownToDocxGenerator

This library is used to generate a docx file from a folder containing markdown files.

==========

Onboarding Instructions

Installation

1. Add nuget package:

Install-Package MarkdownToDocxGenerator

2. In your application, you can initialize the tools in the service collection. Open your program.cs or Startup.cs and add the following code:

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureServices((hostContext, services) =>
            {
                services.AddMarkdownToDocxGenerator();
            });

Note : The library used the ILogger class to generate logs. So you need to register the logger before calling the AddMarkdownToDocxGenerator function.

A MdReportGenenerator object is now registered in the dependency injection container. You can now inject it in your services or controllers.

    public class MyService
    {
        private readonly MdReportGenenerator reportGenerator;

        public MyService(MdReportGenenerator reportGenerator)
        {
            this.reportGenerator = reportGenerator;
        }
    }

Usage

To work, you need to call the function GenerateReport :

    public class MyService
    {
        private readonly MdReportGenenerator reportGenerator;

        public MyService(MdReportGenenerator reportGenerator)
        {
            this.reportGenerator = reportGenerator;
        }

        public void GenerateReport()
        {
            var rootFolder = Path.Combine(Environment.CurrentDirectory, "MdFiles");
            var templatePath = Path.Combine(Environment.CurrentDirectory, "Dotx/sample.dotx");
            var outputPath = Path.Combine(Environment.CurrentDirectory, "Dotx/sample.docx");
            
            reportGenerator.Transform(outputPath, rootFolder, templatePath);
        }
    }

The function Transform has 3 parameters :

• outputPath : The path of the output file (Docx file)
• rootFolder : The path of the folder containing the markdown files (MdFiles/*.md)
• templatePath : The path of the template file (Optional. It let you to use a dotx file as template)

IC

Documentation : I want more

Do not hesitate to check unit tests on the solution. It's a good way to check how transformations are tested.

Also, to get more samples, go to the Wiki.

Do not hesitate to contribute.

Support / Contribute

If you have any questions, problems or suggestions, create an issue or fork the project and create a Pull Request.

You want more ? Feel free to create an issue or contribute by adding new functionnalities by forking the project and create a pull request.

And if y like this project, don't forget to star it !

You can also support me with a coffee :