Giter Club home page Giter Club logo

mtrpz_labs's Introduction

Markdown to HTML Converter

Description

This Python application converts Markdown files to HTML format. It supports the conversion of basic Markdown syntax, including bold, italic, and inline code, to their HTML counterparts. The application also includes validation for nested and correct usage of Markdown syntax to ensure the output HTML is as expected.

Guide Installation

Prerequisites

  • Python 3.x

Installation

Clone the repository to your local machine:

git clone https://github.com/heereenveen/mtrpz_1lab

Running the Application

To convert a Markdown file to HTML, run the main.py script with the input file name as an argument. Optionally, you can specify an output file name to save the converted HTML:

python main.py input_file.md --out output_file.html

If no output file is specified, the program will print the converted HTML to standard output.

User Guide

Supported Markdown Features

  • Bold: Wrap your text with ** to make it bold. For example, **bold text** converts to <strong>bold text</strong>.
  • Italic: Use _ to italicize your text. For instance, _italic text_ becomes <em>italic text</em>.
  • Inline Code: To format text as inline code, enclose it with backticks (`). For example, `code` turns into <code>code</code>.

Validation

The application checks for incorrect nesting and unmatched symbols to ensure the Markdown is correctly formed before conversion.

Error Handling

If there are any issues with the Markdown syntax or if the input file cannot be found, the application will provide an error message and terminate the execution to prevent incorrect HTML conversion.

Revert-commit

The following link.

Failure commit for CI tests:

The following link.

Conclusions about Unit-Tests:

I can confidently say that the time spent writing unit tests was a very worthwhile investment for me. After all, writing unit tests allows you to ensure high code quality and detect errors at the early stages of development, which greatly facilitates the work of the developer.

mtrpz_labs's People

Contributors

anasteishat avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.