markdown parser

Markdown Parser Application

CSS

Markdown Parser

Responsive Mockup

🎯 Goal

Markdown Parser is a PHP-based tool for converting Markdown files to HTML, designed to simplify content formatting. This project emphasizes flexibility in presenting structured content on the web.

💻 Stack

HTML
CSS
JavaScript
jQuery
AJAX
PHP

The project is fully responsive, ensuring it works across all devices.

🏗️ Installation

Follow these steps to set up and run the project using XAMPP.

Step 1: Install XAMPP

Download XAMPP: Go to the XAMPP download page and download the installer for your operating system.
Run the Installer: Open the downloaded installer and follow the prompts to install XAMPP. Choose the default options for a smooth setup.
Verify Installation: After installation, open the XAMPP control panel to ensure XAMPP is installed correctly.

Step 2: Prepare the Project Files

Fork the repository by clicking the Fork button at the top-right of the repository page.
Clone your forked repository locally

git clone https://github.com/your-username/repo-name.git

Navigate to the project directory

cd repo-name

Move Project to XAMPP: Copy the repo-name directory to the htdocs directory, typically found at C:\xampp\htdocs on Windows or /opt/lampp/htdocs on Linux.

Step 3: Start the XAMPP Apache Server

Open XAMPP Control Panel: Start the XAMPP control panel application.
Start Apache: In the control panel, locate the Apache service and click “Start” to start the web server. Ensure that Apache is running (its status should be “Running” in green).

Step 4: Set Up a Virtual Host (Optional but Recommended)

Edit the vhosts file C:\xampp\apache\conf\extra\httpd-vhosts.conf (Windows) or /opt/lampp/etc/extra/httpd-vhosts.conf (Linux).
Add the following lines at the bottom of the file:

<VirtualHost *:80>
    DocumentRoot "C:/xampp/htdocs/repo-name"
    ServerName repo-name.local
    DirectoryIndex index.html index.php

    <Directory "C:/xampp/htdocs/repo-name">
        AllowOverride All
        Require all granted
    </Directory>
</VirtualHost>

Adjust the file paths if your XAMPP is installed in a different directory.

Add an entry for repo-name.local in your system’s hosts file:
- On Windows, open C:\Windows\System32\drivers\etc\hosts in a text editor with administrator privileges.
- On Linux, edit /etc/hosts with root privileges.
Add the following line, 127.0.0.1 repo-name.local
Restart Apache: After saving these changes, go back to the XAMPP control panel and restart Apache to apply the new virtual host configuration.

Step 5: Access the Application

Open a Web Browser: Launch your preferred web browser.
Visit the Application: Go to http://repo-name.local (or http://localhost/repo-name if you didn’t set up a virtual host).
Verify the Setup: The homepage of the application should now load, indicating the application is ready to use.

⚓ Contributing

Contributions are welcome and greatly appreciated! If you’d like to contribute to this project, please follow these steps:

Fork the repository by clicking the Fork button at the top-right of the repository page.
Clone your forked repository locally

git clone https://github.com/your-username/repo-name.git

Create a new branch for your contribution

git checkout -b feature/your-feature-name

Make your changes and ensure your code is clean and properly formatted.
Commit your changes

git commit -m "feat: your feature description"

Push your branch to your forked repository

git push origin feature/your-feature-name

Submit a Pull Request (PR) by going to the original repository and clicking the “New Pull Request” button.

📋 Contribution Guidelines

Ensure your changes are well-tested and documented.
Adhere to the existing code style and project structure.
Provide clear descriptions in your PR regarding the changes and enhancements.
Be open to feedback and discussion in the PR review process.

✉️ Contact

🔓 License

If you find my work good, consider giving it a ⭐ or fork-ing to show some ❤️. It helps me stay on track and be motivated.