Giter VIP home page Giter VIP logo

holbertonschool-markdown2html's Introduction

Markdown to HTML

Python Version PEP8 Compliant

Convert-Markdown-to-HTML-in-Java-using-REST-API

๐Ÿง Project Overview

Welcome to the "Markdown to HTML" project! In this project, you'll learn how to convert Markdown files into HTML. You'll utilize Python 3.7 or higher, ensuring PEP 8 style compliance. This project is designed to strengthen your Python skills while introducing you to the intricacies of parsing and processing text.

๐ŸŒฑ Learning Objectives

By the end of this project, you'll be able to:

  • Understand and use Python 3.7 or higher
  • Convert Markdown files into HTML
  • Follow the PEP 8 style guide
  • Document your modules effectively
  • Ensure that your code is executable and follows best practices

โš™๏ธ Requirements

To successfully run this project, make sure you have:

  • Python 3.7 or higher installed
  • PEP 8 compliant style (you can use a tool like autopep8 for formatting)
  • Executable files with the shebang #!/usr/bin/python3
  • A well-documented README.md file at the root of your project
  • Modules that adhere to PEP 8 and include proper documentation
  • Code that is not executed when imported (use if __name__ == "__main__":)

๐Ÿง‘๐Ÿปโ€๐Ÿ’ป Usage

The script takes two arguments from the CLI:

  • First argument is the name of the Markdown file
  • Second argument is the output file name
python3 markdown2html.py README.md README.html

๐Ÿง Supported Markdown Syntax

  • Headings
Markdown HTML Generated
# Heading level 1 <h1>Heading level 1</h1>
## Heading level 2 <h2>Heading level 2</h1>
### Heading level 3 <h3>Heading level 1</h1>
#### Heading level 4 <h4>Heading level 1</h4>
##### Heading level 5 <h5>Heading level 1</h5>
###### Heading level 6 <h6>Heading level 1</h6>
  • Unordered listing

โžค Markdown

- Hello

- Bye

โžค HTML Generated

<ul>
    <li>Hello</li>
    <li>Bye</li>
</ul>
  • Ordered listing

โžค Markdown

* Hello

* Bye

โžค HTML Generated

<ol>
    <li>Hello</li>
    <li>Bye</li>
</ol>
  • Simple text

โžค Markdown

Hello

I'm a text
with 2 lines

โžค HTML Generated

<p>
    Hello
</p>
<p>
    I'm a text
        <br />
    with 2 lines
</p>
  • Bold and emphasis text
Markdown HTML Generated
**Hello** <b>Hello</b>
__Hello__ <em>Hello</em>
  • Just for fun
Markdown HTML Generated Description
[[Hello]] 8b1a9953c4611296a827abf8c47804d7 convert in MD5 (lowercase) the content
((Hello Chicago)) Hello hiago remove all c (case insensitive) from the content

๐Ÿง‘โ€๐Ÿ’ป Author

holbertonschool-markdown2html's People

Contributors

v-dav 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.